Class Address
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Address.Builder,
Address>
Describes an Elastic IP address, or a carrier IP address.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID representing the allocation of the address.final String
The ID representing the association of the address with an instance.static Address.Builder
builder()
final String
The carrier IP address associated.final String
The customer-owned IP address.final String
The ID of the customer-owned address pool.final DomainType
domain()
The network (vpc
).final String
The network (vpc
).final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The ID of the instance that the address is associated with (if any).final String
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.final String
The ID of the network interface.final String
The ID of the Amazon Web Services account that owns the network interface.final String
The private IP address associated with the Elastic IP address.final String
publicIp()
The Elastic IP address.final String
The ID of an address pool.static Class
<? extends Address.Builder> tags()
Any tags assigned to the Elastic IP address.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Elastic IP address.
- Returns:
- The Elastic IP address.
-
allocationId
The ID representing the allocation of the address.
- Returns:
- The ID representing the allocation of the address.
-
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
The network (
vpc
).If the service returns an enum value that is not available in the current SDK version,
domain
will returnDomainType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainAsString()
.- Returns:
- The network (
vpc
). - See Also:
-
domainAsString
The network (
vpc
).If the service returns an enum value that is not available in the current SDK version,
domain
will returnDomainType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainAsString()
.- Returns:
- The network (
vpc
). - See Also:
-
networkInterfaceId
The ID of the network interface.
- Returns:
- The ID of the network interface.
-
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
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 theisEmpty()
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
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
The ID of an address pool.
- Returns:
- The ID of an address pool.
-
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
The customer-owned IP address.
- Returns:
- The customer-owned IP address.
-
customerOwnedIpv4Pool
The ID of the customer-owned address pool.
- Returns:
- The ID of the customer-owned address pool.
-
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).
-
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 interfaceToCopyableBuilder<Address.Builder,
Address> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-