java.lang.Object
- software.amazon.awssdk.services.ec2.model.PublicIpv4Pool

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PublicIpv4Pool.Builder,PublicIpv4Pool>

@Generated("software.amazon.awssdk:codegen")
public final class PublicIpv4Pool
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PublicIpv4Pool.Builder,PublicIpv4Pool>

Describes an IPv4 address pool.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PublicIpv4Pool.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PublicIpv4Pool.Builder`	`builder()`
`String`	`description()`	A description of the address pool.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPoolAddressRanges()`	For responses, this returns true if the service returned a value for the PoolAddressRanges property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`networkBorderGroup()`	The name of the location from which the address pool is advertised.
`List<PublicIpv4PoolRange>`	`poolAddressRanges()`	The address ranges.
`String`	`poolId()`	The ID of the address pool.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PublicIpv4Pool.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	Any tags for the address pool.
`PublicIpv4Pool.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`totalAddressCount()`	The total number of addresses.
`Integer`	`totalAvailableAddressCount()`	The total number of available addresses.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - poolId
```
public final String poolId()
```
    The ID of the address pool.
    
    Returns:
    
    The ID of the address pool.
  - description
```
public final String description()
```
    A description of the address pool.
    
    Returns:
    
    A description of the address pool.
  - hasPoolAddressRanges
```
public final boolean hasPoolAddressRanges()
```
    For responses, this returns true if the service returned a value for the PoolAddressRanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - poolAddressRanges
```
public final List<PublicIpv4PoolRange> poolAddressRanges()
```
    The address ranges.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPoolAddressRanges() method.
    
    Returns:
    
    The address ranges.
  - totalAddressCount
```
public final Integer totalAddressCount()
```
    The total number of addresses.
    
    Returns:
    
    The total number of addresses.
  - totalAvailableAddressCount
```
public final Integer totalAvailableAddressCount()
```
    The total number of available addresses.
    
    Returns:
    
    The total number of available addresses.
  - networkBorderGroup
```
public final String networkBorderGroup()
```
    The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.
    
    Returns:
    
    The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    Any tags for the address pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    Any tags for the address pool.
  - toBuilder
```
public PublicIpv4Pool.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PublicIpv4Pool.Builder,PublicIpv4Pool>
  - builder
```
public static PublicIpv4Pool.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PublicIpv4Pool.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PublicIpv4Pool

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

poolId

description

hasPoolAddressRanges

poolAddressRanges

totalAddressCount

totalAvailableAddressCount

networkBorderGroup

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields