com.amazonaws.services.waf.model.SizeConstraintSet 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 SizeConstraint objects, which specify the parts of web requests that you
* want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one
* SizeConstraint object, a request only needs to match one constraint to be considered a match.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SizeConstraintSet implements Serializable, Cloneable, StructuredPojo {
/**
*
* A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
* information about a SizeConstraintSet (see GetSizeConstraintSet), update a
* SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into
* a Rule or delete one from a Rule (see UpdateRule), and delete a
* SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
*
*
* SizeConstraintSetId is returned by CreateSizeConstraintSet and by
* ListSizeConstraintSets.
*
*/
private String sizeConstraintSetId;
/**
*
* The name, if any, of the SizeConstraintSet.
*
*/
private String name;
/**
*
* Specifies the parts of web requests that you want to inspect the size of.
*
*/
private java.util.List sizeConstraints;
/**
*
* A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
* information about a SizeConstraintSet (see GetSizeConstraintSet), update a
* SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into
* a Rule or delete one from a Rule (see UpdateRule), and delete a
* SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
*
*
* SizeConstraintSetId is returned by CreateSizeConstraintSet and by
* ListSizeConstraintSets.
*
*
* @param sizeConstraintSetId
* A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
* information about a SizeConstraintSet (see GetSizeConstraintSet), update a
* SizeConstraintSet (see UpdateSizeConstraintSet), insert a
* SizeConstraintSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete a SizeConstraintSet from AWS WAF (see
* DeleteSizeConstraintSet).
*
* SizeConstraintSetId is returned by CreateSizeConstraintSet and by
* ListSizeConstraintSets.
*/
public void setSizeConstraintSetId(String sizeConstraintSetId) {
this.sizeConstraintSetId = sizeConstraintSetId;
}
/**
*
* A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
* information about a SizeConstraintSet (see GetSizeConstraintSet), update a
* SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into
* a Rule or delete one from a Rule (see UpdateRule), and delete a
* SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
*
*
* SizeConstraintSetId is returned by CreateSizeConstraintSet and by
* ListSizeConstraintSets.
*
*
* @return A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
* information about a SizeConstraintSet (see GetSizeConstraintSet), update a
* SizeConstraintSet (see UpdateSizeConstraintSet), insert a
* SizeConstraintSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete a SizeConstraintSet from AWS WAF (see
* DeleteSizeConstraintSet).
*
* SizeConstraintSetId is returned by CreateSizeConstraintSet and by
* ListSizeConstraintSets.
*/
public String getSizeConstraintSetId() {
return this.sizeConstraintSetId;
}
/**
*
* A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
* information about a SizeConstraintSet (see GetSizeConstraintSet), update a
* SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into
* a Rule or delete one from a Rule (see UpdateRule), and delete a
* SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
*
*
* SizeConstraintSetId is returned by CreateSizeConstraintSet and by
* ListSizeConstraintSets.
*
*
* @param sizeConstraintSetId
* A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
* information about a SizeConstraintSet (see GetSizeConstraintSet), update a
* SizeConstraintSet (see UpdateSizeConstraintSet), insert a
* SizeConstraintSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete a SizeConstraintSet from AWS WAF (see
* DeleteSizeConstraintSet).
*
* SizeConstraintSetId is returned by CreateSizeConstraintSet and by
* ListSizeConstraintSets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SizeConstraintSet withSizeConstraintSetId(String sizeConstraintSetId) {
setSizeConstraintSetId(sizeConstraintSetId);
return this;
}
/**
*
* The name, if any, of the SizeConstraintSet.
*
*
* @param name
* The name, if any, of the SizeConstraintSet.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name, if any, of the SizeConstraintSet.
*
*
* @return The name, if any, of the SizeConstraintSet.
*/
public String getName() {
return this.name;
}
/**
*
* The name, if any, of the SizeConstraintSet.
*
*
* @param name
* The name, if any, of the SizeConstraintSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SizeConstraintSet withName(String name) {
setName(name);
return this;
}
/**
*
* Specifies the parts of web requests that you want to inspect the size of.
*
*
* @return Specifies the parts of web requests that you want to inspect the size of.
*/
public java.util.List getSizeConstraints() {
return sizeConstraints;
}
/**
*
* Specifies the parts of web requests that you want to inspect the size of.
*
*
* @param sizeConstraints
* Specifies the parts of web requests that you want to inspect the size of.
*/
public void setSizeConstraints(java.util.Collection sizeConstraints) {
if (sizeConstraints == null) {
this.sizeConstraints = null;
return;
}
this.sizeConstraints = new java.util.ArrayList(sizeConstraints);
}
/**
*
* Specifies the parts of web requests that you want to inspect the size of.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSizeConstraints(java.util.Collection)} or {@link #withSizeConstraints(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param sizeConstraints
* Specifies the parts of web requests that you want to inspect the size of.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SizeConstraintSet withSizeConstraints(SizeConstraint... sizeConstraints) {
if (this.sizeConstraints == null) {
setSizeConstraints(new java.util.ArrayList(sizeConstraints.length));
}
for (SizeConstraint ele : sizeConstraints) {
this.sizeConstraints.add(ele);
}
return this;
}
/**
*
* Specifies the parts of web requests that you want to inspect the size of.
*
*
* @param sizeConstraints
* Specifies the parts of web requests that you want to inspect the size of.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SizeConstraintSet withSizeConstraints(java.util.Collection sizeConstraints) {
setSizeConstraints(sizeConstraints);
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 (getSizeConstraintSetId() != null)
sb.append("SizeConstraintSetId: ").append(getSizeConstraintSetId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getSizeConstraints() != null)
sb.append("SizeConstraints: ").append(getSizeConstraints());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SizeConstraintSet == false)
return false;
SizeConstraintSet other = (SizeConstraintSet) obj;
if (other.getSizeConstraintSetId() == null ^ this.getSizeConstraintSetId() == null)
return false;
if (other.getSizeConstraintSetId() != null && other.getSizeConstraintSetId().equals(this.getSizeConstraintSetId()) == 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.getSizeConstraints() == null ^ this.getSizeConstraints() == null)
return false;
if (other.getSizeConstraints() != null && other.getSizeConstraints().equals(this.getSizeConstraints()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSizeConstraintSetId() == null) ? 0 : getSizeConstraintSetId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getSizeConstraints() == null) ? 0 : getSizeConstraints().hashCode());
return hashCode;
}
@Override
public SizeConstraintSet clone() {
try {
return (SizeConstraintSet) 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.SizeConstraintSetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}