Class Address

java.lang.Object
software.amazon.awssdk.services.ec2.model.Address
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Address.Builder,Address>
@Generated("software.amazon.awssdk:codegen") public final class Address extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Address.Builder,Address>

Describes an Elastic IP address, or a carrier IP address.

See Also:

  • Method Details

    • allocationId

      public final String allocationId()

      The ID representing the allocation of the address.

      Returns:
      The ID representing the allocation of the address.

    • associationId

      public final String associationId()

      The ID representing the association of the address with an instance.

      Returns:
      The ID representing the association of the address with an instance.

    • domain

      public final DomainType domain()

      The network (vpc).

      If the service returns an enum value that is not available in the current SDK version, domain will return DomainType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

      Returns:
      The network (vpc).
      See Also:

    • domainAsString

      public final String domainAsString()

      The network (vpc).

      If the service returns an enum value that is not available in the current SDK version, domain will return DomainType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

      Returns:
      The network (vpc).
      See Also:

    • networkInterfaceId

      public final String networkInterfaceId()

      The ID of the network interface.

      Returns:
      The ID of the network interface.

    • networkInterfaceOwnerId

      public final String networkInterfaceOwnerId()

      The ID of the Amazon Web Services account that owns the network interface.

      Returns:
      The ID of the Amazon Web Services account that owns the network interface.

    • privateIpAddress

      public final String privateIpAddress()

      The private IP address associated with the Elastic IP address.

      Returns:
      The private IP address associated with the Elastic IP address.

    • 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 assigned to the Elastic IP address.

      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 assigned to the Elastic IP address.

    • publicIpv4Pool

      public final String publicIpv4Pool()

      The ID of an address pool.

      Returns:
      The ID of an address pool.

    • networkBorderGroup

      public final String networkBorderGroup()

      The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

      Returns:
      The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

    • customerOwnedIp

      public final String customerOwnedIp()

      The customer-owned IP address.

      Returns:
      The customer-owned IP address.

    • customerOwnedIpv4Pool

      public final String customerOwnedIpv4Pool()

      The ID of the customer-owned address pool.

      Returns:
      The ID of the customer-owned address pool.

    • carrierIp

      public final String carrierIp()

      The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

      Returns:
      The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

    • instanceId

      public final String instanceId()

      The ID of the instance that the address is associated with (if any).

      Returns:
      The ID of the instance that the address is associated with (if any).

    • publicIp

      public final String publicIp()

      The Elastic IP address.

      Returns:
      The Elastic IP address.

    • toBuilder

      public Address.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<Address.Builder,Address>
      Returns:
      a builder for type T

    • builder

      public static Address.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Address.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.