com.amazonaws.services.waf.model.GeoMatchSet 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.
*
*
*
* Contains one or more countries that AWS WAF will search for.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GeoMatchSet implements Serializable, Cloneable, StructuredPojo {
/**
*
* The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get
* information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see
* UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see
* DeleteGeoMatchSet).
*
*
* GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*
*/
private String geoMatchSetId;
/**
*
* A friendly name or description of the GeoMatchSet. You can't change the name of an
* GeoMatchSet after you create it.
*
*/
private String name;
/**
*
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
*
*/
private java.util.List geoMatchConstraints;
/**
*
* The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get
* information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see
* UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see
* DeleteGeoMatchSet).
*
*
* GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*
*
* @param geoMatchSetId
* The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get
* information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet
* (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one
* from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see
* DeleteGeoMatchSet).
*
* GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*/
public void setGeoMatchSetId(String geoMatchSetId) {
this.geoMatchSetId = geoMatchSetId;
}
/**
*
* The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get
* information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see
* UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see
* DeleteGeoMatchSet).
*
*
* GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*
*
* @return The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get
* information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet
* (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one
* from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see
* DeleteGeoMatchSet).
*
* GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*/
public String getGeoMatchSetId() {
return this.geoMatchSetId;
}
/**
*
* The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get
* information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see
* UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see
* DeleteGeoMatchSet).
*
*
* GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
*
*
* @param geoMatchSetId
* The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get
* information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet
* (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one
* from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see
* DeleteGeoMatchSet).
*
* GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GeoMatchSet withGeoMatchSetId(String geoMatchSetId) {
setGeoMatchSetId(geoMatchSetId);
return this;
}
/**
*
* A friendly name or description of the GeoMatchSet. You can't change the name of an
* GeoMatchSet after you create it.
*
*
* @param name
* A friendly name or description of the GeoMatchSet. You can't change the name of an
* GeoMatchSet after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name or description of the GeoMatchSet. You can't change the name of an
* GeoMatchSet after you create it.
*
*
* @return A friendly name or description of the GeoMatchSet. You can't change the name of an
* GeoMatchSet after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name or description of the GeoMatchSet. You can't change the name of an
* GeoMatchSet after you create it.
*
*
* @param name
* A friendly name or description of the GeoMatchSet. You can't change the name of an
* GeoMatchSet after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GeoMatchSet withName(String name) {
setName(name);
return this;
}
/**
*
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
*
*
* @return An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search
* for.
*/
public java.util.List getGeoMatchConstraints() {
return geoMatchConstraints;
}
/**
*
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
*
*
* @param geoMatchConstraints
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search
* for.
*/
public void setGeoMatchConstraints(java.util.Collection geoMatchConstraints) {
if (geoMatchConstraints == null) {
this.geoMatchConstraints = null;
return;
}
this.geoMatchConstraints = new java.util.ArrayList(geoMatchConstraints);
}
/**
*
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGeoMatchConstraints(java.util.Collection)} or {@link #withGeoMatchConstraints(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param geoMatchConstraints
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search
* for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GeoMatchSet withGeoMatchConstraints(GeoMatchConstraint... geoMatchConstraints) {
if (this.geoMatchConstraints == null) {
setGeoMatchConstraints(new java.util.ArrayList(geoMatchConstraints.length));
}
for (GeoMatchConstraint ele : geoMatchConstraints) {
this.geoMatchConstraints.add(ele);
}
return this;
}
/**
*
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
*
*
* @param geoMatchConstraints
* An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search
* for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GeoMatchSet withGeoMatchConstraints(java.util.Collection geoMatchConstraints) {
setGeoMatchConstraints(geoMatchConstraints);
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 (getGeoMatchSetId() != null)
sb.append("GeoMatchSetId: ").append(getGeoMatchSetId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getGeoMatchConstraints() != null)
sb.append("GeoMatchConstraints: ").append(getGeoMatchConstraints());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GeoMatchSet == false)
return false;
GeoMatchSet other = (GeoMatchSet) obj;
if (other.getGeoMatchSetId() == null ^ this.getGeoMatchSetId() == null)
return false;
if (other.getGeoMatchSetId() != null && other.getGeoMatchSetId().equals(this.getGeoMatchSetId()) == 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.getGeoMatchConstraints() == null ^ this.getGeoMatchConstraints() == null)
return false;
if (other.getGeoMatchConstraints() != null && other.getGeoMatchConstraints().equals(this.getGeoMatchConstraints()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGeoMatchSetId() == null) ? 0 : getGeoMatchSetId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getGeoMatchConstraints() == null) ? 0 : getGeoMatchConstraints().hashCode());
return hashCode;
}
@Override
public GeoMatchSet clone() {
try {
return (GeoMatchSet) 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.GeoMatchSetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}