com.amazonaws.services.waf.model.XssMatchSet 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.
*
*
*
* A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you
* want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of
* the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs
* to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class XssMatchSet implements Serializable, Cloneable, StructuredPojo {
/**
*
* A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about
* an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see
* UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see
* DeleteXssMatchSet).
*
*
* XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*
*/
private String xssMatchSetId;
/**
*
* The name, if any, of the XssMatchSet.
*
*/
private String name;
/**
*
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
*
*/
private java.util.List xssMatchTuples;
/**
*
* A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about
* an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see
* UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see
* DeleteXssMatchSet).
*
*
* XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*
*
* @param xssMatchSetId
* A unique identifier for an XssMatchSet. You use XssMatchSetId to get information
* about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see
* UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from
* a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see
* DeleteXssMatchSet).
*
* XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*/
public void setXssMatchSetId(String xssMatchSetId) {
this.xssMatchSetId = xssMatchSetId;
}
/**
*
* A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about
* an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see
* UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see
* DeleteXssMatchSet).
*
*
* XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*
*
* @return A unique identifier for an XssMatchSet. You use XssMatchSetId to get
* information about an XssMatchSet (see GetXssMatchSet), update an
* XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a
* Rule or delete one from a Rule (see UpdateRule), and delete an
* XssMatchSet from AWS WAF (see DeleteXssMatchSet).
*
* XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*/
public String getXssMatchSetId() {
return this.xssMatchSetId;
}
/**
*
* A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about
* an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see
* UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see
* DeleteXssMatchSet).
*
*
* XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
*
*
* @param xssMatchSetId
* A unique identifier for an XssMatchSet. You use XssMatchSetId to get information
* about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see
* UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from
* a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see
* DeleteXssMatchSet).
*
* XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public XssMatchSet withXssMatchSetId(String xssMatchSetId) {
setXssMatchSetId(xssMatchSetId);
return this;
}
/**
*
* The name, if any, of the XssMatchSet.
*
*
* @param name
* The name, if any, of the XssMatchSet.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name, if any, of the XssMatchSet.
*
*
* @return The name, if any, of the XssMatchSet.
*/
public String getName() {
return this.name;
}
/**
*
* The name, if any, of the XssMatchSet.
*
*
* @param name
* The name, if any, of the XssMatchSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public XssMatchSet withName(String name) {
setName(name);
return this;
}
/**
*
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
*
*
* @return Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
*/
public java.util.List getXssMatchTuples() {
return xssMatchTuples;
}
/**
*
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
*
*
* @param xssMatchTuples
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
*/
public void setXssMatchTuples(java.util.Collection xssMatchTuples) {
if (xssMatchTuples == null) {
this.xssMatchTuples = null;
return;
}
this.xssMatchTuples = new java.util.ArrayList(xssMatchTuples);
}
/**
*
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setXssMatchTuples(java.util.Collection)} or {@link #withXssMatchTuples(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param xssMatchTuples
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public XssMatchSet withXssMatchTuples(XssMatchTuple... xssMatchTuples) {
if (this.xssMatchTuples == null) {
setXssMatchTuples(new java.util.ArrayList(xssMatchTuples.length));
}
for (XssMatchTuple ele : xssMatchTuples) {
this.xssMatchTuples.add(ele);
}
return this;
}
/**
*
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
*
*
* @param xssMatchTuples
* Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public XssMatchSet withXssMatchTuples(java.util.Collection xssMatchTuples) {
setXssMatchTuples(xssMatchTuples);
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 (getXssMatchSetId() != null)
sb.append("XssMatchSetId: ").append(getXssMatchSetId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getXssMatchTuples() != null)
sb.append("XssMatchTuples: ").append(getXssMatchTuples());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof XssMatchSet == false)
return false;
XssMatchSet other = (XssMatchSet) obj;
if (other.getXssMatchSetId() == null ^ this.getXssMatchSetId() == null)
return false;
if (other.getXssMatchSetId() != null && other.getXssMatchSetId().equals(this.getXssMatchSetId()) == 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.getXssMatchTuples() == null ^ this.getXssMatchTuples() == null)
return false;
if (other.getXssMatchTuples() != null && other.getXssMatchTuples().equals(this.getXssMatchTuples()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getXssMatchSetId() == null) ? 0 : getXssMatchSetId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getXssMatchTuples() == null) ? 0 : getXssMatchTuples().hashCode());
return hashCode;
}
@Override
public XssMatchSet clone() {
try {
return (XssMatchSet) 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.XssMatchSetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}