information-coordinator-service/src/main/java/org/oransc/ics/controllers/r1consumer/ConsumerTypeRegistrationInfo.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_type_registration_info", description = "Information for an Information type")
  32 public class ConsumerTypeRegistrationInfo {
  33
  34     @Schema(name = "info_type_id", description = "Information type identifier", required = true)
  35     @SerializedName("info_type_id")
  36     @JsonProperty(value = "info_type_id", required = true)
  37     public String infoTypeId;
  38
  39     @Schema(name = "job_data_schema", description = "Json schema for the job data", required = true)
  40     @SerializedName("job_data_schema")
  41     @JsonProperty(value = "job_data_schema", required = true)
  42     public Object jobDataSchema;
  43
  44     @Gson.TypeAdapters
  45     @Schema(name = "consumer_type_registration_values", description = REGISTRATION_DESCRIPTION)
  46     public enum ConsumerTypeStatusValues {
  47         REGISTERED, DEREGISTERED
  48     }
  49
  50     private static final String REGISTRATION_DESCRIPTION = "Allowed values: <br/>" //
  51         + "REGISTERED: the information type has been registered <br/>" //
  52         + "DEREGISTERED: the information type has been removed";
  53
  54     @Schema(name = "status", description = REGISTRATION_DESCRIPTION, required = true)
  55     @SerializedName("status")
  56     @JsonProperty(value = "status", required = true)
  57     public ConsumerTypeStatusValues state;
  58
  59     public ConsumerTypeRegistrationInfo(Object jobDataSchema, ConsumerTypeStatusValues state, String infoTypeId) {
  60         this.jobDataSchema = jobDataSchema;
  61         this.state = state;
  62         this.infoTypeId = infoTypeId;
  63     }
  64
  65     public ConsumerTypeRegistrationInfo() {
  66     }
  67
  68 }