enrichment-coordinator-service/src/main/java/org/oransc/enrichment/controllers/r1consumer/ConsumerJobInfo.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.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 = "Job", description = "Information for an Enrichment Information Job")
  32 public class ConsumerJobInfo {
  33
  34     @Schema(name = "infoTypeId", description = "Information type Idenitifier of the subscription job", required = true)
  35     @SerializedName("infoTypeId")
  36     @JsonProperty(value = "infoTypeId", required = true)
  37     public String infoTypeId;
  38
  39     @Schema(name = "jobOwner", description = "Identity of the owner of the job", required = true)
  40     @SerializedName("jobOwner")
  41     @JsonProperty(value = "jobOwner", required = true)
  42     public String owner;
  43
  44     @Schema(name = "jobDefinition", description = "Information type specific job data", required = true)
  45     @SerializedName("jobDefinition")
  46     @JsonProperty(value = "jobDefinition", required = true)
  47     public Object jobDefinition;
  48
  49     @Schema(name = "jobResultUri", description = "The target URI of the subscribed information", required = true)
  50     @SerializedName("jobResultUri")
  51     @JsonProperty(value = "jobResultUri", required = true)
  52     public String jobResultUri;
  53
  54     @Schema(
  55         name = "statusNotificationUri",
  56         description = "The target of Information subscription job status notifications",
  57         required = false)
  58     @SerializedName("jobStatusNotificationUri")
  59     @JsonProperty(value = "jobStatusNotificationUri", required = false)
  60     public String statusNotificationUri;
  61
  62     public ConsumerJobInfo() {
  63     }
  64
  65     public ConsumerJobInfo(String eiTypeId, Object jobData, String owner, String targetUri,
  66         String statusNotificationUri) {
  67         this.infoTypeId = eiTypeId;
  68         this.jobDefinition = jobData;
  69         this.owner = owner;
  70         this.jobResultUri = targetUri;
  71         this.statusNotificationUri = statusNotificationUri;
  72     }
  73 }