gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2020-2023 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.v3.oas.annotations.media.Schema;
  27
  28 import java.util.Collection;
  29
  30 @Schema(name = "ric_info_v2", description = "Information for a Near-RT RIC")
  31 public class RicInfo {
  32
  33     @Schema(name = "ric_state_v2", description = "Represents the states for a Near-RT RIC")
  34     public enum RicState {
  35         UNAVAILABLE, AVAILABLE, SYNCHRONIZING, CONSISTENCY_CHECK
  36     }
  37
  38     private static final String STATE_DESCRIPTION =
  39             """
  40                     State for the Near-RT RIC, values:
  41                     UNAVAILABLE: The Near-RT RIC is not available, information may be inconsistent
  42                     AVAILABLE: The normal state. Policies can be configured.
  43                     SYNCHRONIZING: The Policy Management Service is synchronizing the view of the Near-RT RIC. Policies cannot be configured.
  44                     CONSISTENCY_CHECK: A consistency check between the Policy Management Service and the Near-RT RIC. Policies cannot be configured.""";
  45
  46     @Schema(description = "identity of the Near-RT RIC")
  47     @SerializedName("ric_id")
  48     @JsonProperty("ric_id")
  49     public final String ricId;
  50
  51     @Schema(description = "O1 identities for managed entities")
  52     @SerializedName("managed_element_ids")
  53     @JsonProperty("managed_element_ids")
  54     public final Collection<String> managedElementIds;
  55
  56     @Schema(description = "supported policy types")
  57     @SerializedName("policytype_ids")
  58     @JsonProperty("policytype_ids")
  59     public final Collection<String> policyTypeIds;
  60
  61     @Schema(description = STATE_DESCRIPTION, name = "state")
  62     @SerializedName("state")
  63     @JsonProperty("state")
  64     public final RicState state;
  65
  66     RicInfo(String ricId, Collection<String> managedElementIds, Collection<String> policyTypes, RicState state) {
  67         this.ricId = ricId;
  68         this.managedElementIds = managedElementIds;
  69         this.policyTypeIds = policyTypes;
  70         this.state = state;
  71     }
  72 }