aboutsummaryrefslogtreecommitdiffstats
path: root/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyInfo.java
blob: 2e19a3de320f8a90f3e5a4b51944687d83da5683 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*-
 * ========================LICENSE_START=================================
 * ONAP : ccsdk oran
 * ======================================================================
 * Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
 * ======================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ========================LICENSE_END===================================
 */

package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.gson.annotations.SerializedName;

import io.swagger.v3.oas.annotations.media.Schema;

import org.immutables.gson.Gson;

@Gson.TypeAdapters
@Schema(name = "policy_info_v2", description = "Information for one A1-P Policy")
public class PolicyInfo {

    @Schema(name = "policy_id", description = "identity of the policy", required = true)
    @JsonProperty(value = "policy_id", required = true)
    @SerializedName("policy_id")
    public String policyId;

    @Schema(name = "policytype_id", description = "identity of the policy type", required = true)
    @JsonProperty(value = "policytype_id", required = true)
    @SerializedName("policytype_id")
    public String policyTypeId;

    @Schema(name = "ric_id", description = "identity of the target Near-RT RIC", required = true)
    @JsonProperty(value = "ric_id", required = true)
    @SerializedName("ric_id")
    public String ricId;

    @Schema(name = "policy_data", description = "the configuration of the policy", required = true)
    @JsonProperty(value = "policy_data", required = true)
    @SerializedName("policy_data")
    public Object policyData;

    @Schema(name = "service_id", description = "the identity of the service owning the policy", required = true)
    @JsonProperty(value = "service_id", required = true)
    @SerializedName("service_id")
    public String serviceId;

    @Schema(name = "transient",
            description = "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",
            required = false)
    @JsonProperty(value = "transient", required = false, defaultValue = "false")
    @SerializedName("transient")
    public boolean isTransient = false;

    @Schema(name = "status_notification_uri", description = "Callback URI for policy status updates", required = false)
    @JsonProperty(value = "status_notification_uri", required = false)
    @SerializedName("status_notification_uri")
    public String statusNotificationUri = "";

    PolicyInfo() {}

    public boolean validate() {
        return policyId != null && policyTypeId != null && ricId != null && policyData != null && serviceId != null;
    }

}