Merge "Merge docs from cherry to master"
[nonrtric.git] / enrichment-coordinator-service / src / main / java / org / oransc / enrichment / controllers / a1e / A1eEiJobStatus.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.a1e;
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 = "EiJobStatusObject", description = "Status for an EI job")
32 public class A1eEiJobStatus {
33
34     @Gson.TypeAdapters
35     @Schema(name = "EiJobStatusValues", description = "Allowed values for EI job status")
36     public enum EiJobStatusValues {
37         ENABLED, DISABLED
38     }
39
40     private static final String OPERATIONAL_STATE_DESCRIPTION = "values:\n" //
41         + "ENABLED: the A1-EI producer is able to deliver EI result for the EI job\n" //
42         + "DISABLED: the A1-EI producer is unable to deliver EI result for the EI job";
43
44     @Schema(name = "eiJobStatus", description = OPERATIONAL_STATE_DESCRIPTION, required = true)
45     @SerializedName("eiJobStatus")
46     @JsonProperty(value = "eiJobStatus", required = true)
47     public EiJobStatusValues state;
48
49     public A1eEiJobStatus() {
50     }
51
52     public A1eEiJobStatus(EiJobStatusValues state) {
53         this.state = state;
54     }
55
56 }