information-coordinator-service/src/main/java/org/oransc/ics/controllers/r1consumer/ConsumerInfoTypeInfo.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2021 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.ics.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 org.immutables.gson.Gson;
  29
  30 @Gson.TypeAdapters
  31 @Schema(name = "consumer_information_type", description = "Information for an Information type")
  32 public class ConsumerInfoTypeInfo {
  33
  34     @Schema(name = "job_data_schema", description = "Json schema for the job data", required = true)
  35     @SerializedName("job_data_schema")
  36     @JsonProperty(value = "job_data_schema", required = true)
  37     public Object jobDataSchema;
  38
  39     @Gson.TypeAdapters
  40     @Schema(name = "consumer_type_status_values", description = STATUS_DESCRIPTION)
  41     public enum ConsumerTypeStatusValues {
  42         ENABLED, DISABLED
  43     }
  44
  45     private static final String STATUS_DESCRIPTION = "Allowed values: <br/>" //
  46         + "ENABLED: one or several producers for the information type are available <br/>" //
  47         + "DISABLED: no producers for the information type are available";
  48
  49     @Schema(name = "type_status", description = STATUS_DESCRIPTION, required = true)
  50     @SerializedName("type_status")
  51     @JsonProperty(value = "type_status", required = true)
  52     public ConsumerTypeStatusValues state;
  53
  54     @Schema(name = "no_of_producers", description = "The number of registered producers for the type", required = true)
  55     @SerializedName("no_of_producers")
  56     @JsonProperty(value = "no_of_producers", required = true)
  57     public int noOfProducers;
  58
  59     public ConsumerInfoTypeInfo(Object jobDataSchema, ConsumerTypeStatusValues state, int noOfProducers) {
  60         this.jobDataSchema = jobDataSchema;
  61         this.state = state;
  62         this.noOfProducers = noOfProducers;
  63     }
  64
  65     public ConsumerInfoTypeInfo() {
  66     }
  67
  68 }