Uplift PMS source from ONAP
[nonrtric.git] / enrichment-coordinator-service / src / main / java / org / oransc / enrichment / controllers / r1producer / ProducerStatusInfo.java
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2019 Nordix Foundation
6  * %%
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ========================LICENSE_END===================================
19  */
20
21 package org.oransc.enrichment.controllers.r1producer;
22
23 import com.fasterxml.jackson.annotation.JsonProperty;
24 import com.google.gson.annotations.SerializedName;
25
26 import io.swagger.v3.oas.annotations.media.Schema;
27
28 import org.immutables.gson.Gson;
29
30 @Gson.TypeAdapters
31 @Schema(name = "producer_status", description = "Status for an Info Producer")
32 public class ProducerStatusInfo {
33
34     @Gson.TypeAdapters
35     @Schema(name = "producer_operational_state", description = "Represents the operational states")
36     public enum OperationalState {
37         ENABLED, DISABLED
38     }
39
40     private static final String OPERATIONAL_STATE_DESCRIPTION = "Operational state, values:\n" //
41         + "ENABLED: the producer is operational\n" //
42         + "DISABLED: the producer is not operational";
43
44     @Schema(name = "operational_state", description = OPERATIONAL_STATE_DESCRIPTION, required = true)
45     @SerializedName("operational_state")
46     @JsonProperty(value = "operational_state", required = true)
47     public final OperationalState opState;
48
49     public ProducerStatusInfo(OperationalState state) {
50         this.opState = state;
51     }
52
53 }