2 * ========================LICENSE_START=================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2;
23 import com.fasterxml.jackson.annotation.JsonProperty;
24 import com.google.gson.annotations.SerializedName;
26 import io.swagger.annotations.ApiModel;
27 import io.swagger.annotations.ApiModelProperty;
29 import java.util.Collection;
31 import org.immutables.gson.Gson;
34 @ApiModel(value = "ric_info_v2", description = "Information for a Near-RT RIC")
35 public class RicInfo {
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
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.";
49 @ApiModelProperty(value = "identity of the Near-RT RIC")
50 @SerializedName("ric_id")
51 @JsonProperty("ric_id")
52 public final String ricId;
54 @ApiModelProperty(value = "O1 identities for managed entities")
55 @SerializedName("managed_element_ids")
56 @JsonProperty("managed_element_ids")
57 public final Collection<String> managedElementIds;
59 @ApiModelProperty(value = "supported policy types")
60 @SerializedName("policy_type_ids")
61 @JsonProperty("policy_type_ids")
62 public final Collection<String> policyTypeIds;
64 @ApiModelProperty(value = STATE_DESCRIPTION, name = "state")
65 @SerializedName("state")
66 @JsonProperty("state")
67 public final RicState state;
69 RicInfo(String ricId, Collection<String> managedElementIds, Collection<String> policyTypes, RicState state) {
71 this.managedElementIds = managedElementIds;
72 this.policyTypeIds = policyTypes;