com.amazonaws.services.waf.model.Predicate Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* 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 java.io.Serializable;
/**
*
* Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, and SizeConstraintSet objects that you want to add
* to a Rule and, for each object, indicates whether you want to
* negate the settings, for example, requests that do NOT originate from the IP
* address 192.0.2.44.
*
*/
public class Predicate implements Serializable, Cloneable {
/**
*
* Set Negated to False if you want AWS WAF to
* allow, block, or count requests based on the settings in the specified
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow or block requests based on that IP address.
*
*
* Set Negated to True if you want AWS WAF to
* allow or block a request based on the negation of the settings in the
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
*
*/
private Boolean negated;
/**
*
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
*
*/
private String type;
/**
*
* A unique identifier for a predicate in a Rule, such as
* ByteMatchSetId or IPSetId. The ID is returned
* by the corresponding Create or List command.
*
*/
private String dataId;
/**
*
* Set Negated to False if you want AWS WAF to
* allow, block, or count requests based on the settings in the specified
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow or block requests based on that IP address.
*
*
* Set Negated to True if you want AWS WAF to
* allow or block a request based on the negation of the settings in the
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
*
*
* @param negated
* Set Negated to False if you want AWS WAF
* to allow, block, or count requests based on the settings in the
* specified ByteMatchSet, IPSet,
* SqlInjectionMatchSet, XssMatchSet, or
* SizeConstraintSet. For example, if an IPSet
* includes the IP address 192.0.2.44, AWS WAF will
* allow or block requests based on that IP address.
*
* Set Negated to True if you want AWS WAF
* to allow or block a request based on the negation of the settings
* in the ByteMatchSet, IPSet,
* SqlInjectionMatchSet, XssMatchSet, or
* SizeConstraintSet. For example, if an IPSet
* includes the IP address 192.0.2.44, AWS WAF will
* allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
*/
public void setNegated(Boolean negated) {
this.negated = negated;
}
/**
*
* Set Negated to False if you want AWS WAF to
* allow, block, or count requests based on the settings in the specified
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow or block requests based on that IP address.
*
*
* Set Negated to True if you want AWS WAF to
* allow or block a request based on the negation of the settings in the
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
*
*
* @return Set Negated to False if you want AWS
* WAF to allow, block, or count requests based on the settings in
* the specified ByteMatchSet, IPSet,
* SqlInjectionMatchSet, XssMatchSet, or
* SizeConstraintSet. For example, if an IPSet
* includes the IP address 192.0.2.44, AWS WAF will
* allow or block requests based on that IP address.
*
* Set Negated to True if you want AWS WAF
* to allow or block a request based on the negation of the settings
* in the ByteMatchSet, IPSet,
* SqlInjectionMatchSet, XssMatchSet, or
* SizeConstraintSet. For example, if an IPSet
* includes the IP address 192.0.2.44, AWS WAF will
* allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
*/
public Boolean getNegated() {
return this.negated;
}
/**
*
* Set Negated to False if you want AWS WAF to
* allow, block, or count requests based on the settings in the specified
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow or block requests based on that IP address.
*
*
* Set Negated to True if you want AWS WAF to
* allow or block a request based on the negation of the settings in the
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
*
*
* @param negated
* Set Negated to False if you want AWS WAF
* to allow, block, or count requests based on the settings in the
* specified ByteMatchSet, IPSet,
* SqlInjectionMatchSet, XssMatchSet, or
* SizeConstraintSet. For example, if an IPSet
* includes the IP address 192.0.2.44, AWS WAF will
* allow or block requests based on that IP address.
*
* Set Negated to True if you want AWS WAF
* to allow or block a request based on the negation of the settings
* in the ByteMatchSet, IPSet,
* SqlInjectionMatchSet, XssMatchSet, or
* SizeConstraintSet. For example, if an IPSet
* includes the IP address 192.0.2.44, AWS WAF will
* allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public Predicate withNegated(Boolean negated) {
setNegated(negated);
return this;
}
/**
*
* Set Negated to False if you want AWS WAF to
* allow, block, or count requests based on the settings in the specified
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow or block requests based on that IP address.
*
*
* Set Negated to True if you want AWS WAF to
* allow or block a request based on the negation of the settings in the
* ByteMatchSet, IPSet, SqlInjectionMatchSet,
* XssMatchSet, or SizeConstraintSet. For example, if an
* IPSet includes the IP address 192.0.2.44, AWS
* WAF will allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
*
*
* @return Set Negated to False if you want AWS
* WAF to allow, block, or count requests based on the settings in
* the specified ByteMatchSet, IPSet,
* SqlInjectionMatchSet, XssMatchSet, or
* SizeConstraintSet. For example, if an IPSet
* includes the IP address 192.0.2.44, AWS WAF will
* allow or block requests based on that IP address.
*
* Set Negated to True if you want AWS WAF
* to allow or block a request based on the negation of the settings
* in the ByteMatchSet, IPSet,
* SqlInjectionMatchSet, XssMatchSet, or
* SizeConstraintSet. For example, if an IPSet
* includes the IP address 192.0.2.44, AWS WAF will
* allow, block, or count requests based on all IP addresses
* except 192.0.2.44.
*/
public Boolean isNegated() {
return this.negated;
}
/**
*
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
*
*
* @param type
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
* @see PredicateType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
*
*
* @return The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
* @see PredicateType
*/
public String getType() {
return this.type;
}
/**
*
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
*
*
* @param type
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see PredicateType
*/
public Predicate withType(String type) {
setType(type);
return this;
}
/**
*
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
*
*
* @param type
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
* @see PredicateType
*/
public void setType(PredicateType type) {
this.type = type.toString();
}
/**
*
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
*
*
* @param type
* The type of predicate in a Rule, such as
* ByteMatchSet or IPSet.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see PredicateType
*/
public Predicate withType(PredicateType type) {
setType(type);
return this;
}
/**
*
* A unique identifier for a predicate in a Rule, such as
* ByteMatchSetId or IPSetId. The ID is returned
* by the corresponding Create or List command.
*
*
* @param dataId
* A unique identifier for a predicate in a Rule, such
* as ByteMatchSetId or IPSetId. The ID is
* returned by the corresponding Create or
* List command.
*/
public void setDataId(String dataId) {
this.dataId = dataId;
}
/**
*
* A unique identifier for a predicate in a Rule, such as
* ByteMatchSetId or IPSetId. The ID is returned
* by the corresponding Create or List command.
*
*
* @return A unique identifier for a predicate in a Rule, such
* as ByteMatchSetId or IPSetId. The ID is
* returned by the corresponding Create or
* List command.
*/
public String getDataId() {
return this.dataId;
}
/**
*
* A unique identifier for a predicate in a Rule, such as
* ByteMatchSetId or IPSetId. The ID is returned
* by the corresponding Create or List command.
*
*
* @param dataId
* A unique identifier for a predicate in a Rule, such
* as ByteMatchSetId or IPSetId. The ID is
* returned by the corresponding Create or
* List command.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public Predicate withDataId(String dataId) {
setDataId(dataId);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getNegated() != null)
sb.append("Negated: " + getNegated() + ",");
if (getType() != null)
sb.append("Type: " + getType() + ",");
if (getDataId() != null)
sb.append("DataId: " + getDataId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Predicate == false)
return false;
Predicate other = (Predicate) obj;
if (other.getNegated() == null ^ this.getNegated() == null)
return false;
if (other.getNegated() != null
&& other.getNegated().equals(this.getNegated()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null
&& other.getType().equals(this.getType()) == false)
return false;
if (other.getDataId() == null ^ this.getDataId() == null)
return false;
if (other.getDataId() != null
&& other.getDataId().equals(this.getDataId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getNegated() == null) ? 0 : getNegated().hashCode());
hashCode = prime * hashCode
+ ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode
+ ((getDataId() == null) ? 0 : getDataId().hashCode());
return hashCode;
}
@Override
public Predicate clone() {
try {
return (Predicate) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}