enrichment-coordinator-service/src/main/java/org/oransc/enrichment/controllers/r1consumer/ConsumerJobStatus.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.r1consumer;
  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 java.util.Collection;
  29
  30 import org.immutables.gson.Gson;
  31
  32 @Gson.TypeAdapters
  33 @Schema(name = "consumer_job_status", description = "Status for an Information Job")
  34 public class ConsumerJobStatus {
  35
  36     @Gson.TypeAdapters
  37     @Schema(name = "info_job_status_values", description = "Allowed values for Information Job status")
  38     public enum InfoJobStatusValues {
  39         ENABLED, DISABLED
  40     }
  41
  42     private static final String OPERATIONAL_STATE_DESCRIPTION = "values:\n" //
  43         + "ENABLED: the A1-Information producer is able to deliver result for the Information Job\n" //
  44         + "DISABLED: the A1-Information producer is unable to deliver result for the Information Job";
  45
  46     private static final String PRODUCERS_DESCRIPTION = "An array of all registerred Information Producer Identifiers.";
  47
  48     @Schema(name = "info_job_status", description = OPERATIONAL_STATE_DESCRIPTION, required = true)
  49     @SerializedName("info_job_status")
  50     @JsonProperty(value = "info_job_status", required = true)
  51     public InfoJobStatusValues state;
  52
  53     @Schema(name = "producers", description = PRODUCERS_DESCRIPTION, required = true)
  54     @SerializedName("producers")
  55     @JsonProperty(value = "producers", required = true)
  56     public Collection<String> producers;
  57
  58     public ConsumerJobStatus() {
  59     }
  60
  61     public ConsumerJobStatus(InfoJobStatusValues state, Collection<String> producers) {
  62         this.state = state;
  63         this.producers = producers;
  64     }
  65
  66 }