com.amazonaws.services.waf.model.RegexPatternSet Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2017-2022 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.
*
*
*
* The RegexPatternSet specifies the regular expression (regex) pattern that you want AWS WAF to search
* for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RegexPatternSet implements Serializable, Cloneable, StructuredPojo {
/**
*
* The identifier for the RegexPatternSet. You use RegexPatternSetId to get information
* about a RegexPatternSet, update a RegexPatternSet, remove a
* RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from
* AWS WAF.
*
*
* RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*
*/
private String regexPatternSetId;
/**
*
* A friendly name or description of the RegexPatternSet. You can't change Name after you create
* a RegexPatternSet.
*
*/
private String name;
/**
*
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
*
*/
private java.util.List regexPatternStrings;
/**
*
* The identifier for the RegexPatternSet. You use RegexPatternSetId to get information
* about a RegexPatternSet, update a RegexPatternSet, remove a
* RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from
* AWS WAF.
*
*
* RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*
*
* @param regexPatternSetId
* The identifier for the RegexPatternSet. You use RegexPatternSetId to get
* information about a RegexPatternSet, update a RegexPatternSet, remove a
* RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet
* from AWS WAF.
*
* RegexMatchSetId is returned by CreateRegexPatternSet and by
* ListRegexPatternSets.
*/
public void setRegexPatternSetId(String regexPatternSetId) {
this.regexPatternSetId = regexPatternSetId;
}
/**
*
* The identifier for the RegexPatternSet. You use RegexPatternSetId to get information
* about a RegexPatternSet, update a RegexPatternSet, remove a
* RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from
* AWS WAF.
*
*
* RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*
*
* @return The identifier for the RegexPatternSet. You use RegexPatternSetId to get
* information about a RegexPatternSet, update a RegexPatternSet, remove a
* RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet
* from AWS WAF.
*
* RegexMatchSetId is returned by CreateRegexPatternSet and by
* ListRegexPatternSets.
*/
public String getRegexPatternSetId() {
return this.regexPatternSetId;
}
/**
*
* The identifier for the RegexPatternSet. You use RegexPatternSetId to get information
* about a RegexPatternSet, update a RegexPatternSet, remove a
* RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from
* AWS WAF.
*
*
* RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*
*
* @param regexPatternSetId
* The identifier for the RegexPatternSet. You use RegexPatternSetId to get
* information about a RegexPatternSet, update a RegexPatternSet, remove a
* RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet
* from AWS WAF.
*
* RegexMatchSetId is returned by CreateRegexPatternSet and by
* ListRegexPatternSets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegexPatternSet withRegexPatternSetId(String regexPatternSetId) {
setRegexPatternSetId(regexPatternSetId);
return this;
}
/**
*
* A friendly name or description of the RegexPatternSet. You can't change Name after you create
* a RegexPatternSet.
*
*
* @param name
* A friendly name or description of the RegexPatternSet. You can't change Name after you
* create a RegexPatternSet.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name or description of the RegexPatternSet. You can't change Name after you create
* a RegexPatternSet.
*
*
* @return A friendly name or description of the RegexPatternSet. You can't change Name after
* you create a RegexPatternSet.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name or description of the RegexPatternSet. You can't change Name after you create
* a RegexPatternSet.
*
*
* @param name
* A friendly name or description of the RegexPatternSet. You can't change Name after you
* create a RegexPatternSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegexPatternSet withName(String name) {
setName(name);
return this;
}
/**
*
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
*
*
* @return Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
*/
public java.util.List getRegexPatternStrings() {
return regexPatternStrings;
}
/**
*
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
*
*
* @param regexPatternStrings
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
*/
public void setRegexPatternStrings(java.util.Collection regexPatternStrings) {
if (regexPatternStrings == null) {
this.regexPatternStrings = null;
return;
}
this.regexPatternStrings = new java.util.ArrayList(regexPatternStrings);
}
/**
*
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRegexPatternStrings(java.util.Collection)} or {@link #withRegexPatternStrings(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param regexPatternStrings
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegexPatternSet withRegexPatternStrings(String... regexPatternStrings) {
if (this.regexPatternStrings == null) {
setRegexPatternStrings(new java.util.ArrayList(regexPatternStrings.length));
}
for (String ele : regexPatternStrings) {
this.regexPatternStrings.add(ele);
}
return this;
}
/**
*
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
*
*
* @param regexPatternStrings
* Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
* B[a@]dB[o0]t.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegexPatternSet withRegexPatternStrings(java.util.Collection regexPatternStrings) {
setRegexPatternStrings(regexPatternStrings);
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 (getRegexPatternSetId() != null)
sb.append("RegexPatternSetId: ").append(getRegexPatternSetId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getRegexPatternStrings() != null)
sb.append("RegexPatternStrings: ").append(getRegexPatternStrings());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RegexPatternSet == false)
return false;
RegexPatternSet other = (RegexPatternSet) obj;
if (other.getRegexPatternSetId() == null ^ this.getRegexPatternSetId() == null)
return false;
if (other.getRegexPatternSetId() != null && other.getRegexPatternSetId().equals(this.getRegexPatternSetId()) == 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.getRegexPatternStrings() == null ^ this.getRegexPatternStrings() == null)
return false;
if (other.getRegexPatternStrings() != null && other.getRegexPatternStrings().equals(this.getRegexPatternStrings()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRegexPatternSetId() == null) ? 0 : getRegexPatternSetId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getRegexPatternStrings() == null) ? 0 : getRegexPatternStrings().hashCode());
return hashCode;
}
@Override
public RegexPatternSet clone() {
try {
return (RegexPatternSet) 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.RegexPatternSetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}