models-errors/src/main/java/org/onap/policy/models/errors/concepts/ErrorResponse.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy Decision Models
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2023 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.errors.concepts;
  23
  24 import com.google.gson.annotations.SerializedName;
  25 import jakarta.ws.rs.core.Response;
  26 import java.io.Serial;
  27 import java.io.Serializable;
  28 import java.util.List;
  29 import lombok.Data;
  30
  31 /**
  32  * This class is for defining a common error/warning
  33  * response from API calls in the Policy Framework.
  34  *
  35  * @author pameladragosh
  36  */
  37 @Data
  38 public class ErrorResponse implements Serializable {
  39     @Serial
  40     private static final long serialVersionUID = 6760066094588944729L;
  41
  42     @SerializedName("code")
  43     private Response.Status responseCode;
  44     @SerializedName("error")
  45     private String errorMessage;
  46     @SerializedName("details")
  47     private List<String> errorDetails;
  48     @SerializedName("warnings")
  49     private List<String> warningDetails;
  50
  51 }