com.amazonaws.services.waf.model.RegexMatchSet Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2015-2020 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.
*
*
*
* In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the
* RegexMatchSetId and Name of a RegexMatchSet, and the values that you specified
* when you updated the RegexMatchSet.
*
*
* The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you
* want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains
* more than one RegexMatchTuple object, a request needs to match the settings in only one
* ByteMatchTuple to be considered a match.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RegexMatchSet implements Serializable, Cloneable, StructuredPojo {
/**
*
* The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get
* information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet
* (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from
* a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see
* DeleteRegexMatchSet).
*
*
* RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*
*/
private String regexMatchSetId;
/**
*
* A friendly name or description of the RegexMatchSet. You can't change Name after you create a
* RegexMatchSet.
*
*/
private String name;
/**
*
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see
* RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for
* the specified string.
*
*
*
*/
private java.util.List regexMatchTuples;
/**
*
* The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get
* information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet
* (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from
* a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see
* DeleteRegexMatchSet).
*
*
* RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*
*
* @param regexMatchSetId
* The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to
* get information about a RegexMatchSet (see GetRegexMatchSet), update a
* RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a
* Rule or delete one from a Rule (see UpdateRule), and delete a
* RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).
*
* RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*/
public void setRegexMatchSetId(String regexMatchSetId) {
this.regexMatchSetId = regexMatchSetId;
}
/**
*
* The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get
* information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet
* (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from
* a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see
* DeleteRegexMatchSet).
*
*
* RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*
*
* @return The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId
* to get information about a RegexMatchSet (see GetRegexMatchSet), update a
* RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a
* Rule or delete one from a Rule (see UpdateRule), and delete a
* RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).
*
* RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*/
public String getRegexMatchSetId() {
return this.regexMatchSetId;
}
/**
*
* The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get
* information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet
* (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from
* a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see
* DeleteRegexMatchSet).
*
*
* RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
*
*
* @param regexMatchSetId
* The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to
* get information about a RegexMatchSet (see GetRegexMatchSet), update a
* RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a
* Rule or delete one from a Rule (see UpdateRule), and delete a
* RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).
*
* RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegexMatchSet withRegexMatchSetId(String regexMatchSetId) {
setRegexMatchSetId(regexMatchSetId);
return this;
}
/**
*
* A friendly name or description of the RegexMatchSet. You can't change Name after you create a
* RegexMatchSet.
*
*
* @param name
* A friendly name or description of the RegexMatchSet. You can't change Name after you
* create a RegexMatchSet.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name or description of the RegexMatchSet. You can't change Name after you create a
* RegexMatchSet.
*
*
* @return A friendly name or description of the RegexMatchSet. You can't change Name after you
* create a RegexMatchSet.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name or description of the RegexMatchSet. You can't change Name after you create a
* RegexMatchSet.
*
*
* @param name
* A friendly name or description of the RegexMatchSet. You can't change Name after you
* create a RegexMatchSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegexMatchSet withName(String name) {
setName(name);
return this;
}
/**
*
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see
* RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for
* the specified string.
*
*
*
*
* @return Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more
* information, see RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting
* it for the specified string.
*
*
*/
public java.util.List getRegexMatchTuples() {
return regexMatchTuples;
}
/**
*
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see
* RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for
* the specified string.
*
*
*
*
* @param regexMatchTuples
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more
* information, see RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting
* it for the specified string.
*
*
*/
public void setRegexMatchTuples(java.util.Collection regexMatchTuples) {
if (regexMatchTuples == null) {
this.regexMatchTuples = null;
return;
}
this.regexMatchTuples = new java.util.ArrayList(regexMatchTuples);
}
/**
*
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see
* RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for
* the specified string.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRegexMatchTuples(java.util.Collection)} or {@link #withRegexMatchTuples(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param regexMatchTuples
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more
* information, see RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting
* it for the specified string.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegexMatchSet withRegexMatchTuples(RegexMatchTuple... regexMatchTuples) {
if (this.regexMatchTuples == null) {
setRegexMatchTuples(new java.util.ArrayList(regexMatchTuples.length));
}
for (RegexMatchTuple ele : regexMatchTuples) {
this.regexMatchTuples.add(ele);
}
return this;
}
/**
*
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see
* RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for
* the specified string.
*
*
*
*
* @param regexMatchTuples
* Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
*
*
* -
*
* The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
* User-Agent header.
*
*
* -
*
* The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more
* information, see RegexPatternSet.
*
*
* -
*
* Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting
* it for the specified string.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegexMatchSet withRegexMatchTuples(java.util.Collection regexMatchTuples) {
setRegexMatchTuples(regexMatchTuples);
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 (getRegexMatchSetId() != null)
sb.append("RegexMatchSetId: ").append(getRegexMatchSetId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getRegexMatchTuples() != null)
sb.append("RegexMatchTuples: ").append(getRegexMatchTuples());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RegexMatchSet == false)
return false;
RegexMatchSet other = (RegexMatchSet) obj;
if (other.getRegexMatchSetId() == null ^ this.getRegexMatchSetId() == null)
return false;
if (other.getRegexMatchSetId() != null && other.getRegexMatchSetId().equals(this.getRegexMatchSetId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getRegexMatchTuples() == null ^ this.getRegexMatchTuples() == null)
return false;
if (other.getRegexMatchTuples() != null && other.getRegexMatchTuples().equals(this.getRegexMatchTuples()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRegexMatchSetId() == null) ? 0 : getRegexMatchSetId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getRegexMatchTuples() == null) ? 0 : getRegexMatchTuples().hashCode());
return hashCode;
}
@Override
public RegexMatchSet clone() {
try {
return (RegexMatchSet) 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.RegexMatchSetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}