com.amazonaws.services.waf.model.WafAction Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* 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.waf.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
*
* This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
* developer guide.
*
*
* For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the
* latest version, AWS WAF has a single set of endpoints for regional and global use.
*
*
*
* For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to
* perform when a web request matches all of the conditions in a rule. For the default action in a WebACL,
* specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of
* the rules in a WebACL.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class WafAction implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid
* settings include the following:
*
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule.
* AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify
* COUNT for the default action for a WebACL.
*
*
*
*/
private String type;
/**
*
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid
* settings include the following:
*
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule.
* AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify
* COUNT for the default action for a WebACL.
*
*
*
*
* @param type
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule.
* Valid settings include the following:
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the
* rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You
* can't specify COUNT for the default action for a WebACL.
*
*
* @see WafActionType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid
* settings include the following:
*
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule.
* AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify
* COUNT for the default action for a WebACL.
*
*
*
*
* @return Specifies how you want AWS WAF to respond to requests that match the settings in a Rule.
* Valid settings include the following:
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the
* rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You
* can't specify COUNT for the default action for a WebACL.
*
*
* @see WafActionType
*/
public String getType() {
return this.type;
}
/**
*
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid
* settings include the following:
*
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule.
* AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify
* COUNT for the default action for a WebACL.
*
*
*
*
* @param type
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule.
* Valid settings include the following:
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the
* rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You
* can't specify COUNT for the default action for a WebACL.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see WafActionType
*/
public WafAction withType(String type) {
setType(type);
return this;
}
/**
*
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid
* settings include the following:
*
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule.
* AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify
* COUNT for the default action for a WebACL.
*
*
*
*
* @param type
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule.
* Valid settings include the following:
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the
* rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You
* can't specify COUNT for the default action for a WebACL.
*
*
* @see WafActionType
*/
public void setType(WafActionType type) {
withType(type);
}
/**
*
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid
* settings include the following:
*
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule.
* AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify
* COUNT for the default action for a WebACL.
*
*
*
*
* @param type
* Specifies how you want AWS WAF to respond to requests that match the settings in a Rule.
* Valid settings include the following:
*
* -
*
* ALLOW: AWS WAF allows requests
*
*
* -
*
* BLOCK: AWS WAF blocks requests
*
*
* -
*
* COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the
* rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You
* can't specify COUNT for the default action for a WebACL.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see WafActionType
*/
public WafAction withType(WafActionType type) {
this.type = type.toString();
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof WafAction == false)
return false;
WafAction other = (WafAction) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public WafAction clone() {
try {
return (WafAction) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.waf.model.waf_regional.transform.WafActionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}