Class PublicIpv4Pool

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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PublicIpv4Pool.Builder,PublicIpv4Pool>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.