com.amazonaws.services.waf.model.IPSet Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2010-2016 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;
/**
*
* Contains one or more IP addresses or blocks of IP addresses specified in
* Classless Inter-Domain Routing (CIDR) notation. To specify an individual IP
* address, you specify the four-part IP address followed by a /32,
* for example, 192.0.2.0/31. To block a range of IP addresses, you can specify
* a /24, a /16, or a /8 CIDR. For more
* information about CIDR notation, perform an Internet search on
* cidr notation.
*
*/
public class IPSet implements Serializable, Cloneable {
/**
*
* 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) and the IP address range (in CIDR
* notation) that web requests originate from. If the WebACL is
* associated with a CloudFront distribution, this is the value of one of
* the following fields in CloudFront access logs:
*
*
* c-ip, if the viewer did not use an HTTP proxy or a load
* balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or
* a load balancer to send the request
*/
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) and the IP address range (in CIDR
* notation) that web requests originate from. If the WebACL is
* associated with a CloudFront distribution, this is the value of one of
* the following fields in CloudFront access logs:
*
*
* c-ip, if the viewer did not use an HTTP proxy or a load
* balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or
* a load balancer to send the request
*
* @return The IP address type (IPV4) and the IP address range
* (in CIDR notation) that web requests originate from. If the
* WebACL is associated with a CloudFront distribution,
* this is the value of one of the following fields in CloudFront
* access logs:
*
* c-ip, if the viewer did not use an HTTP proxy or
* a load balancer to send the requestx-forwarded-for, if the viewer did use an HTTP
* proxy or a load balancer to send the request getIPSetDescriptors() {
return iPSetDescriptors;
}
/**
*
* The IP address type (IPV4) and the IP address range (in CIDR
* notation) that web requests originate from. If the WebACL is
* associated with a CloudFront distribution, this is the value of one of
* the following fields in CloudFront access logs:
*
*
* c-ip, if the viewer did not use an HTTP proxy or a load
* balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or
* a load balancer to send the request
*
* @param iPSetDescriptors
* The IP address type (IPV4) and the IP address range
* (in CIDR notation) that web requests originate from. If the
* WebACL is associated with a CloudFront distribution,
* this is the value of one of the following fields in CloudFront
* access logs:
*
* c-ip, if the viewer did not use an HTTP proxy or
* a load balancer to send the requestx-forwarded-for, if the viewer did use an HTTP
* proxy or a load balancer to send the request iPSetDescriptors) {
if (iPSetDescriptors == null) {
this.iPSetDescriptors = null;
return;
}
this.iPSetDescriptors = new java.util.ArrayList(
iPSetDescriptors);
}
/**
*
* The IP address type (IPV4) and the IP address range (in CIDR
* notation) that web requests originate from. If the WebACL is
* associated with a CloudFront distribution, this is the value of one of
* the following fields in CloudFront access logs:
*
*
* c-ip, if the viewer did not use an HTTP proxy or a load
* balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or
* a load balancer to send the request
*
* 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) and the IP address range
* (in CIDR notation) that web requests originate from. If the
* WebACL is associated with a CloudFront distribution,
* this is the value of one of the following fields in CloudFront
* access logs:
*
* c-ip, if the viewer did not use an HTTP proxy or
* a load balancer to send the requestx-forwarded-for, if the viewer did use an HTTP
* proxy or a load balancer to send the request(
iPSetDescriptors.length));
}
for (IPSetDescriptor ele : iPSetDescriptors) {
this.iPSetDescriptors.add(ele);
}
return this;
}
/**
*
* The IP address type (IPV4) and the IP address range (in CIDR
* notation) that web requests originate from. If the WebACL is
* associated with a CloudFront distribution, this is the value of one of
* the following fields in CloudFront access logs:
*
*
* c-ip, if the viewer did not use an HTTP proxy or a load
* balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or
* a load balancer to send the request
*
* @param iPSetDescriptors
* The IP address type (IPV4) and the IP address range
* (in CIDR notation) that web requests originate from. If the
* WebACL is associated with a CloudFront distribution,
* this is the value of one of the following fields in CloudFront
* access logs:
*
* c-ip, if the viewer did not use an HTTP proxy or
* a load balancer to send the requestx-forwarded-for, if the viewer did use an HTTP
* proxy or a load balancer to send the request iPSetDescriptors) {
setIPSetDescriptors(iPSetDescriptors);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getIPSetId() + ",");
if (getName() != null)
sb.append("Name: " + getName() + ",");
if (getIPSetDescriptors() != null)
sb.append("IPSetDescriptors: " + 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);
}
}
}