com.amazonaws.services.waf.model.WAFInvalidParameterException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-waf Show documentation
The AWS Java SDK for AWS WAF Service module holds the client classes that are used for communicating with AWS WAF Service
There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2010-2016 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.waf.model;

import com.amazonaws.AmazonServiceException;

/**
 * 
 * The operation failed because AWS WAF didn't recognize a parameter in the
 * request. For example:
 * 
 * 
 * You specified an invalid parameter name.
 * You specified an invalid value.
 * You tried to update an object (ByteMatchSet,
 * IPSet, Rule, or WebACL) using an
 * action other than INSERT or DELETE.
 * You tried to create a WebACL with a
 * DefaultAction Type other than ALLOW,
 * BLOCK, or COUNT.
 * You tried to update a WebACL with a WafAction
 * Type other than ALLOW, BLOCK, or
 * COUNT.
 * You tried to update a ByteMatchSet with a
 * FieldToMatch Type other than HEADER, QUERY_STRING,
 * or URI.
 * You tried to update a ByteMatchSet with a Field
 * of HEADER but no value for Data.
 * 
 */
public class WAFInvalidParameterException extends AmazonServiceException {
    private static final long serialVersionUID = 1L;

    @com.fasterxml.jackson.annotation.JsonProperty("field")
    private String field;

    @com.fasterxml.jackson.annotation.JsonProperty("parameter")
    private String parameter;

    @com.fasterxml.jackson.annotation.JsonProperty("reason")
    private String reason;

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

    /**
     * @param field
     * @see ParameterExceptionField
     */

    public void setField(String field) {
        this.field = field;
    }

    /**
     * @return
     * @see ParameterExceptionField
     */

    public String getField() {
        return this.field;
    }

    /**
     * @param field
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ParameterExceptionField
     */

    public WAFInvalidParameterException withField(String field) {
        setField(field);
        return this;
    }

    /**
     * @param field
     * @see ParameterExceptionField
     */

    public void setField(ParameterExceptionField field) {
        this.field = field.toString();
    }

    /**
     * @param field
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ParameterExceptionField
     */

    public WAFInvalidParameterException withField(ParameterExceptionField field) {
        setField(field);
        return this;
    }

    /**
     * @param parameter
     */

    public void setParameter(String parameter) {
        this.parameter = parameter;
    }

    /**
     * @return
     */

    public String getParameter() {
        return this.parameter;
    }

    /**
     * @param parameter
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public WAFInvalidParameterException withParameter(String parameter) {
        setParameter(parameter);
        return this;
    }

    /**
     * @param reason
     * @see ParameterExceptionReason
     */

    public void setReason(String reason) {
        this.reason = reason;
    }

    /**
     * @return
     * @see ParameterExceptionReason
     */

    public String getReason() {
        return this.reason;
    }

    /**
     * @param reason
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ParameterExceptionReason
     */

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

    /**
     * @param reason
     * @see ParameterExceptionReason
     */

    public void setReason(ParameterExceptionReason reason) {
        this.reason = reason.toString();
    }

    /**
     * @param reason
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ParameterExceptionReason
     */

    public WAFInvalidParameterException withReason(
            ParameterExceptionReason reason) {
        setReason(reason);
        return this;
    }

}