IPSetDescriptor (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.waf.model.IPSetDescriptor

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IPSetDescriptor
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IPSetDescriptor()

Constructors
Constructor and Description
`IPSetDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPSetDescriptor`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getType()` Specify `IPV4` or `IPV6`.
`String`	`getValue()` Specify an IPv4 address by using CIDR notation.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setType(IPSetDescriptorType type)` Specify `IPV4` or `IPV6`.
`void`	`setType(String type)` Specify `IPV4` or `IPV6`.
`void`	`setValue(String value)` Specify an IPv4 address by using CIDR notation.
`String`	`toString()` Returns a string representation of this object.
`IPSetDescriptor`	`withType(IPSetDescriptorType type)` Specify `IPV4` or `IPV6`.
`IPSetDescriptor`	`withType(String type)` Specify `IPV4` or `IPV6`.
`IPSetDescriptor`	`withValue(String value)` Specify an IPv4 address by using CIDR notation.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IPSetDescriptor
```
public IPSetDescriptor()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    Specify IPV4 or IPV6.
    
    Parameters:
    
    type - Specify IPV4 or IPV6.
    
    See Also:
    
    IPSetDescriptorType
  - getType
```
public String getType()
```
    Specify IPV4 or IPV6.
    
    Returns:
    
    Specify IPV4 or IPV6.
    
    See Also:
    
    IPSetDescriptorType
  - withType
```
public IPSetDescriptor withType(String type)
```
    Specify IPV4 or IPV6.
    
    Parameters:
    
    type - Specify IPV4 or IPV6.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IPSetDescriptorType
  - setType
```
public void setType(IPSetDescriptorType type)
```
    Specify IPV4 or IPV6.
    
    Parameters:
    
    type - Specify IPV4 or IPV6.
    
    See Also:
    
    IPSetDescriptorType
  - withType
```
public IPSetDescriptor withType(IPSetDescriptorType type)
```
    Specify IPV4 or IPV6.
    
    Parameters:
    
    type - Specify IPV4 or IPV6.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IPSetDescriptorType
  - setValue
```
public void setValue(String value)
```
    Specify an IPv4 address by using CIDR notation. For example:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Specify an IPv6 address by using CIDR notation. For example:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    Parameters:
    value - Specify an IPv4 address by using CIDR notation. For example:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Specify an IPv6 address by using CIDR notation. For example:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
  - getValue
```
public String getValue()
```
    Specify an IPv4 address by using CIDR notation. For example:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Specify an IPv6 address by using CIDR notation. For example:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    Returns:
    Specify an IPv4 address by using CIDR notation. For example:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Specify an IPv6 address by using CIDR notation. For example:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
  - withValue
```
public IPSetDescriptor withValue(String value)
```
    Specify an IPv4 address by using CIDR notation. For example:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Specify an IPv6 address by using CIDR notation. For example:
    - To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    Parameters:
    value - Specify an IPv4 address by using CIDR notation. For example:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Specify an IPv6 address by using CIDR notation. For example:
    
    To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    
    To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IPSetDescriptor clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class IPSetDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IPSetDescriptor

Method Detail

setType

getType

withType

setType

withType

setValue

getValue

withValue

toString

equals

hashCode

clone

marshall