RTD Doc update with error code
[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / api / NcmpResponseStatus.java
1 /*
2  *  ============LICENSE_START=======================================================
3  *  Copyright (C) 2023 Nordix Foundation
4  *  ================================================================================
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at
8  *
9  *        http://www.apache.org/licenses/LICENSE-2.0
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  *
17  *  SPDX-License-Identifier: Apache-2.0
18  *  ============LICENSE_END=========================================================
19  */
20
21 package org.onap.cps.ncmp.api;
22
23 import lombok.Getter;
24
25 @Getter
26 public enum NcmpResponseStatus {
27
28     SUCCESS("0", "Successfully applied changes"),
29     SUCCESSFULLY_APPLIED_SUBSCRIPTION("1", "successfully applied subscription"),
30     CM_HANDLES_NOT_FOUND("100", "cm handle id(s) not found"),
31     CM_HANDLES_NOT_READY("101", "cm handle(s) not ready"),
32     DMI_SERVICE_NOT_RESPONDING("102", "dmi plugin service is not responding"),
33     UNABLE_TO_READ_RESOURCE_DATA("103", "dmi plugin service is not able to read resource data"),
34     PARTIALLY_APPLIED_SUBSCRIPTION("104", "partially applied subscription"),
35     SUBSCRIPTION_NOT_APPLICABLE("105", "subscription not applicable for all cm handles"),
36     SUBSCRIPTION_PENDING("106", "subscription pending for all cm handles"),
37     UNKNOWN_ERROR("108", "Unknown error"),
38     CM_HANDLE_ALREADY_EXIST("109", "cm-handle already exists"),
39     CM_HANDLE_INVALID_ID("110", "cm-handle has an invalid character(s) in id");
40
41     private final String code;
42     private final String message;
43
44     NcmpResponseStatus(final String code, final String message) {
45         this.code = code;
46         this.message = message;
47     }
48 }