webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/ProducerRegistrationInfo.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2020 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.portal.nonrtric.controlpanel.model;
  22
  23 import com.google.gson.annotations.SerializedName;
  24
  25 import io.swagger.annotations.ApiModel;
  26 import io.swagger.annotations.ApiModelProperty;
  27
  28 import java.util.Collection;
  29
  30 import lombok.Builder;
  31
  32 import org.immutables.gson.Gson;
  33
  34 @Gson.TypeAdapters
  35 @ApiModel(value = "producer_registration_info", description = "Information for an EI producer")
  36 @Builder
  37 public class ProducerRegistrationInfo {
  38
  39     @Gson.TypeAdapters
  40     @ApiModel(value = "producer_ei_type_registration_info", description = "Information for an EI type")
  41     @Builder
  42     public static class ProducerEiTypeRegistrationInfo {
  43
  44         @ApiModelProperty(value = "EI type identity", required = true)
  45         @SerializedName("ei_type_identity")
  46         public String eiTypeId;
  47
  48         @ApiModelProperty(value = "Json schema for the job data")
  49         @SerializedName("ei_job_data_schema")
  50         public Object jobDataSchema;
  51     }
  52
  53     @ApiModelProperty(value = "Supported EI type IDs", required = true)
  54     @SerializedName("supported_ei_types")
  55     public Collection<String> supportedTypeIds;
  56
  57     @ApiModelProperty(value = "callback for EI job", required = true)
  58     @SerializedName("ei_job_callback_url")
  59     public String jobCallbackUrl;
  60
  61     @ApiModelProperty(value = "callback for producer supervision", required = true)
  62     @SerializedName("ei_producer_supervision_callback_url")
  63     public String producerSupervisionCallbackUrl;
  64 }