com.amazonaws.services.waf.model.IPSet Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2016-2021 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 IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR)
* notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6
* address ranges: /24, /32, /48, /56, /64, and /128.
*
*
* To specify an individual IP address, you specify the four-part IP address followed by a /32, for
* example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for
* IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia
* entry Classless Inter-Domain Routing.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IPSet implements Serializable, Cloneable, StructuredPojo {
/**
*
* The IPSetId for an IPSet. You use IPSetId to get information about an
* IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an
* IPSet into a Rule or delete one from a Rule (see UpdateRule), and
* delete an IPSet from AWS WAF (see DeleteIPSet).
*
*
* IPSetId is returned by CreateIPSet and by ListIPSets.
*
*/
private String iPSetId;
/**
*
* A friendly name or description of the IPSet. You can't change the name of an IPSet after you
* create it.
*
*/
private String name;
/**
*
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web
* requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer
* did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the
* CloudFront access logs.
*
*/
private java.util.List iPSetDescriptors;
/**
*
* The IPSetId for an IPSet. You use IPSetId to get information about an
* IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an
* IPSet into a Rule or delete one from a Rule (see UpdateRule), and
* delete an IPSet from AWS WAF (see DeleteIPSet).
*
*
* IPSetId is returned by CreateIPSet and by ListIPSets.
*
*
* @param iPSetId
* The IPSetId for an IPSet. You use IPSetId to get information about
* an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert
* an IPSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).
*
* IPSetId is returned by CreateIPSet and by ListIPSets.
*/
public void setIPSetId(String iPSetId) {
this.iPSetId = iPSetId;
}
/**
*
* The IPSetId for an IPSet. You use IPSetId to get information about an
* IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an
* IPSet into a Rule or delete one from a Rule (see UpdateRule), and
* delete an IPSet from AWS WAF (see DeleteIPSet).
*
*
* IPSetId is returned by CreateIPSet and by ListIPSets.
*
*
* @return The IPSetId for an IPSet. You use IPSetId to get information about
* an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet),
* insert an IPSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).
*
* IPSetId is returned by CreateIPSet and by ListIPSets.
*/
public String getIPSetId() {
return this.iPSetId;
}
/**
*
* The IPSetId for an IPSet. You use IPSetId to get information about an
* IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an
* IPSet into a Rule or delete one from a Rule (see UpdateRule), and
* delete an IPSet from AWS WAF (see DeleteIPSet).
*
*
* IPSetId is returned by CreateIPSet and by ListIPSets.
*
*
* @param iPSetId
* The IPSetId for an IPSet. You use IPSetId to get information about
* an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert
* an IPSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).
*
* IPSetId is returned by CreateIPSet and by ListIPSets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IPSet withIPSetId(String iPSetId) {
setIPSetId(iPSetId);
return this;
}
/**
*
* A friendly name or description of the IPSet. You can't change the name of an IPSet after you
* create it.
*
*
* @param name
* A friendly name or description of the IPSet. You can't change the name of an IPSet
* after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name or description of the IPSet. You can't change the name of an IPSet after you
* create it.
*
*
* @return A friendly name or description of the IPSet. You can't change the name of an IPSet
* after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name or description of the IPSet. You can't change the name of an IPSet after you
* create it.
*
*
* @param name
* A friendly name or description of the IPSet. You can't change the name of an IPSet
* after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IPSet withName(String name) {
setName(name);
return this;
}
/**
*
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web
* requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer
* did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the
* CloudFront access logs.
*
*
* @return The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation)
* that web requests originate from. If the WebACL is associated with a CloudFront distribution
* and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the
* c-ip field in the CloudFront access logs.
*/
public java.util.List getIPSetDescriptors() {
return iPSetDescriptors;
}
/**
*
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web
* requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer
* did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the
* CloudFront access logs.
*
*
* @param iPSetDescriptors
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation)
* that web requests originate from. If the WebACL is associated with a CloudFront distribution
* and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the
* c-ip field in the CloudFront access logs.
*/
public void setIPSetDescriptors(java.util.Collection iPSetDescriptors) {
if (iPSetDescriptors == null) {
this.iPSetDescriptors = null;
return;
}
this.iPSetDescriptors = new java.util.ArrayList(iPSetDescriptors);
}
/**
*
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web
* requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer
* did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the
* CloudFront access logs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setIPSetDescriptors(java.util.Collection)} or {@link #withIPSetDescriptors(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param iPSetDescriptors
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation)
* that web requests originate from. If the WebACL is associated with a CloudFront distribution
* and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the
* c-ip field in the CloudFront access logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IPSet withIPSetDescriptors(IPSetDescriptor... iPSetDescriptors) {
if (this.iPSetDescriptors == null) {
setIPSetDescriptors(new java.util.ArrayList(iPSetDescriptors.length));
}
for (IPSetDescriptor ele : iPSetDescriptors) {
this.iPSetDescriptors.add(ele);
}
return this;
}
/**
*
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web
* requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer
* did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the
* CloudFront access logs.
*
*
* @param iPSetDescriptors
* The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation)
* that web requests originate from. If the WebACL is associated with a CloudFront distribution
* and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the
* c-ip field in the CloudFront access logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IPSet withIPSetDescriptors(java.util.Collection iPSetDescriptors) {
setIPSetDescriptors(iPSetDescriptors);
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 (getIPSetId() != null)
sb.append("IPSetId: ").append(getIPSetId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getIPSetDescriptors() != null)
sb.append("IPSetDescriptors: ").append(getIPSetDescriptors());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IPSet == false)
return false;
IPSet other = (IPSet) obj;
if (other.getIPSetId() == null ^ this.getIPSetId() == null)
return false;
if (other.getIPSetId() != null && other.getIPSetId().equals(this.getIPSetId()) == 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.getIPSetDescriptors() == null ^ this.getIPSetDescriptors() == null)
return false;
if (other.getIPSetDescriptors() != null && other.getIPSetDescriptors().equals(this.getIPSetDescriptors()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIPSetId() == null) ? 0 : getIPSetId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getIPSetDescriptors() == null) ? 0 : getIPSetDescriptors().hashCode());
return hashCode;
}
@Override
public IPSet clone() {
try {
return (IPSet) 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.IPSetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}