com.amazonaws.services.docdbelastic.model.ValidationException Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.docdbelastic.model;

import javax.annotation.Generated;

/**
 * 
 * A structure defining a validation exception.
 * 
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ValidationException extends com.amazonaws.services.docdbelastic.model.AmazonDocDBElasticException {
    private static final long serialVersionUID = 1L;

    /**
     * 
     * A list of the fields in which the validation exception occurred.
     * 
     */
    private java.util.List fieldList;
    /**
     * 
     * The reason why the validation exception occurred (one of unknownOperation, cannotParse,
     * fieldValidationFailed, or other).
     * 
     */
    private String reason;

    /**
     * Constructs a new ValidationException with the specified error message.
     *
     * @param message
     *        Describes the error encountered.
     */
    public ValidationException(String message) {
        super(message);
    }

    /**
     * 
     * A list of the fields in which the validation exception occurred.
     * 
     * 
     * @return A list of the fields in which the validation exception occurred.
     */

    @com.fasterxml.jackson.annotation.JsonProperty("fieldList")
    public java.util.List getFieldList() {
        return fieldList;
    }

    /**
     * 
     * A list of the fields in which the validation exception occurred.
     * 
     * 
     * @param fieldList
     *        A list of the fields in which the validation exception occurred.
     */

    @com.fasterxml.jackson.annotation.JsonProperty("fieldList")
    public void setFieldList(java.util.Collection fieldList) {
        if (fieldList == null) {
            this.fieldList = null;
            return;
        }

        this.fieldList = new java.util.ArrayList(fieldList);
    }

    /**
     * 
     * A list of the fields in which the validation exception occurred.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setFieldList(java.util.Collection)} or {@link #withFieldList(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param fieldList
     *        A list of the fields in which the validation exception occurred.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ValidationException withFieldList(ValidationExceptionField... fieldList) {
        if (this.fieldList == null) {
            setFieldList(new java.util.ArrayList(fieldList.length));
        }
        for (ValidationExceptionField ele : fieldList) {
            this.fieldList.add(ele);
        }
        return this;
    }

    /**
     * 
     * A list of the fields in which the validation exception occurred.
     * 
     * 
     * @param fieldList
     *        A list of the fields in which the validation exception occurred.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ValidationException withFieldList(java.util.Collection fieldList) {
        setFieldList(fieldList);
        return this;
    }

    /**
     * 
     * The reason why the validation exception occurred (one of unknownOperation, cannotParse,
     * fieldValidationFailed, or other).
     * 
     * 
     * @param reason
     *        The reason why the validation exception occurred (one of unknownOperation,
     *        cannotParse, fieldValidationFailed, or other).
     * @see ValidationExceptionReason
     */

    @com.fasterxml.jackson.annotation.JsonProperty("reason")
    public void setReason(String reason) {
        this.reason = reason;
    }

    /**
     * 
     * The reason why the validation exception occurred (one of unknownOperation, cannotParse,
     * fieldValidationFailed, or other).
     * 
     * 
     * @return The reason why the validation exception occurred (one of unknownOperation,
     *         cannotParse, fieldValidationFailed, or other).
     * @see ValidationExceptionReason
     */

    @com.fasterxml.jackson.annotation.JsonProperty("reason")
    public String getReason() {
        return this.reason;
    }

    /**
     * 
     * The reason why the validation exception occurred (one of unknownOperation, cannotParse,
     * fieldValidationFailed, or other).
     * 
     * 
     * @param reason
     *        The reason why the validation exception occurred (one of unknownOperation,
     *        cannotParse, fieldValidationFailed, or other).
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ValidationExceptionReason
     */

    public ValidationException withReason(String reason) {
        setReason(reason);
        return this;
    }

    /**
     * 
     * The reason why the validation exception occurred (one of unknownOperation, cannotParse,
     * fieldValidationFailed, or other).
     * 
     * 
     * @param reason
     *        The reason why the validation exception occurred (one of unknownOperation,
     *        cannotParse, fieldValidationFailed, or other).
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ValidationExceptionReason
     */

    public ValidationException withReason(ValidationExceptionReason reason) {
        this.reason = reason.toString();
        return this;
    }

}