Minor documentation improvements
[nonrtric.git] / enrichment-coordinator-service / src / main / java / org / oransc / enrichment / controllers / producer / ProducerJobInfo.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.producer;
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 import org.oransc.enrichment.repository.EiJob;
31
32 @Gson.TypeAdapters
33 @ApiModel(
34     value = "producer_ei_job_request",
35     description = "The body of the EI producer callbacks for EI job creation and deletion")
36 public class ProducerJobInfo {
37
38     @ApiModelProperty(value = "Idenitity of the EI job", required = true)
39     @SerializedName("ei_job_identity")
40     @JsonProperty("ei_job_identity")
41     public String id;
42
43     @ApiModelProperty(value = "Type idenitity for the job")
44     @SerializedName("ei_type_identity")
45     @JsonProperty("ei_type_identity")
46     public String typeId;
47
48     @ApiModelProperty(value = "Json for the job data")
49     @SerializedName("ei_job_data")
50     @JsonProperty("ei_job_data")
51     public Object jobData;
52
53     @ApiModelProperty(value = "URI for the target of the EI")
54     @SerializedName("target_uri")
55     @JsonProperty("target_uri")
56     public String targetUri;
57
58     @ApiModelProperty(value = "The owner of the job")
59     @SerializedName("owner")
60     @JsonProperty("owner")
61     public String owner;
62
63     @ApiModelProperty(value = "The time when the job was last updated or created (ISO-8601)")
64     @SerializedName("last_updated")
65     @JsonProperty("last_updated")
66     public String lastUpdated;
67
68     public ProducerJobInfo(Object jobData, String id, String typeId, String targetUri, String owner,
69         String lastUpdated) {
70         this.id = id;
71         this.jobData = jobData;
72         this.typeId = typeId;
73         this.targetUri = targetUri;
74         this.owner = owner;
75         this.lastUpdated = lastUpdated;
76     }
77
78     public ProducerJobInfo(EiJob job) {
79         this(job.getJobData(), job.getId(), job.getTypeId(), job.getTargetUrl(), job.getOwner(), job.getLastUpdated());
80     }
81
82     public ProducerJobInfo() {
83     }
84
85 }