enrichment-coordinator-service/src/main/java/org/oransc/enrichment/controllers/consumer/ConsumerEiJobInfo.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.enrichment.controllers.consumer;
  22
  23 import com.fasterxml.jackson.annotation.JsonProperty;
  24 import com.google.gson.annotations.SerializedName;
  25
  26 import io.swagger.annotations.ApiModel;
  27 import io.swagger.annotations.ApiModelProperty;
  28
  29 import org.immutables.gson.Gson;
  30
  31 @Gson.TypeAdapters
  32 @ApiModel(value = "EiJobObject", description = "Information for an Enrichment Information Job")
  33 public class ConsumerEiJobInfo {
  34
  35     @ApiModelProperty(value = "EI type Idenitifier of the EI job", required = true)
  36     @SerializedName("eiTypeId")
  37     @JsonProperty(value = "eiTypeId", required = true)
  38     public String eiTypeId;
  39
  40     @ApiModelProperty(value = "Identity of the owner of the job", required = true)
  41     @SerializedName("jobOwner")
  42     @JsonProperty(value = "jobOwner", required = true)
  43     public String owner;
  44
  45     @ApiModelProperty(value = "EI type specific job data", required = true)
  46     @SerializedName("jobDefinition")
  47     @JsonProperty(value = "jobDefinition", required = true)
  48     public Object jobData;
  49
  50     @ApiModelProperty(value = "The target URI of the EI data", required = true)
  51     @SerializedName("jobResultUri")
  52     @JsonProperty(value = "jobResultUri", required = true)
  53     public String targetUri;
  54
  55     @ApiModelProperty(value = "The target of EI job status notifications", required = false)
  56     @SerializedName("jobStatusNotificationUri")
  57     @JsonProperty(value = "jobStatusNotificationUri", required = false)
  58     public String statusNotificationUri;
  59
  60     public ConsumerEiJobInfo() {
  61     }
  62
  63     public ConsumerEiJobInfo(String eiTypeId, Object jobData, String owner, String targetUri) {
  64         this.eiTypeId = eiTypeId;
  65         this.jobData = jobData;
  66         this.owner = owner;
  67         this.targetUri = targetUri;
  68     }
  69 }