938d5106226504714f888c8b343ce6c025739a90
[ccsdk/oran.git] /
1 /*-
2  * ========================LICENSE_START=================================
3  * ONAP : ccsdk oran
4  * ======================================================================
5  * Copyright (C) 2020 Nordix Foundation. All rights reserved.
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.onap.ccsdk.oran.a1policymanagementservice.controllers.v2;
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 java.util.Collection;
30
31 import org.immutables.gson.Gson;
32
33 @Gson.TypeAdapters
34 @ApiModel(value = "ric_info_v2", description = "Information for a Near-RT RIC")
35 public class RicInfo {
36
37     @Gson.TypeAdapters
38     @ApiModel(value = "ric_state_v2", description = "Represents the states for a Near-RT RIC")
39     public enum RicState {
40         UNAVAILABLE, AVAILABLE, SYNCHRONIZING, CONSISTENCY_CHECK
41     }
42
43     private static final String STATE_DESCRIPTION = "State for the Near-RT RIC, values: \n"
44             + "UNAVAILABLE: The Near-RT RIC is not avialable, information may be inconsistent \n"
45             + "AVAILABLE: The normal state. Policies can be configured. +\n"
46             + "SYNCHRONIZING: The Policy Management Service is synchronizing the view of the Near-RT RIC. Policies cannot be configured. \n"
47             + "CONSISTENCY_CHECK: A consistency check between the Policy Management Service and the Near-RT RIC. Policies cannot be configured.";
48
49     @ApiModelProperty(value = "identity of the Near-RT RIC")
50     @SerializedName("ric_id")
51     @JsonProperty("ric_id")
52     public final String ricId;
53
54     @ApiModelProperty(value = "O1 identities for managed entities")
55     @SerializedName("managed_element_ids")
56     @JsonProperty("managed_element_ids")
57     public final Collection<String> managedElementIds;
58
59     @ApiModelProperty(value = "supported policy types")
60     @SerializedName("policy_type_ids")
61     @JsonProperty("policy_type_ids")
62     public final Collection<String> policyTypeIds;
63
64     @ApiModelProperty(value = STATE_DESCRIPTION, name = "state")
65     @SerializedName("state")
66     @JsonProperty("state")
67     public final RicState state;
68
69     RicInfo(String ricId, Collection<String> managedElementIds, Collection<String> policyTypes, RicState state) {
70         this.ricId = ricId;
71         this.managedElementIds = managedElementIds;
72         this.policyTypeIds = policyTypes;
73         this.state = state;
74     }
75 }