43643abc290f31e89056dad76dc9868c09c971c3
[nonrtric.git] / enrichment-coordinator-service / src / main / java / org / oransc / enrichment / controllers / consumer / ConsumerEiJobStatus.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.consumer;
22
23 import com.fasterxml.jackson.annotation.JsonProperty;
24 import com.google.gson.annotations.SerializedName;
25
26 import io.swagger.annotations.ApiModel;
27 import io.swagger.annotations.ApiModelProperty;
28
29 import org.immutables.gson.Gson;
30
31 @Gson.TypeAdapters
32 @ApiModel(value = "EiJobStatus", description = "Status for an EI Job")
33 public class ConsumerEiJobStatus {
34
35     @Gson.TypeAdapters
36     @ApiModel(value = "OperationalState", description = "Represents the operational states for a EI Job")
37     public enum OperationalState {
38         ENABLED, DISABLED
39     }
40
41     private static final String OPERATIONAL_STATE_DESCRIPTION = "Operational state, values:\n" //
42         + "ENABLED: TBD\n" //
43         + "DISABLED: TBD.";
44
45     @ApiModelProperty(value = OPERATIONAL_STATE_DESCRIPTION, name = "operational_state", required = true)
46     @SerializedName("operationalState")
47     @JsonProperty(value = "operationalState", required = true)
48     public final OperationalState state;
49
50     public ConsumerEiJobStatus(OperationalState state) {
51         this.state = state;
52     }
53
54 }