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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Address.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
allocationId()
The ID representing the allocation of the address.String
associationId()
The ID representing the association of the address with an instance.static Address.Builder
builder()
String
carrierIp()
The carrier IP address associated.String
customerOwnedIp()
The customer-owned IP address.String
customerOwnedIpv4Pool()
The ID of the customer-owned address pool.DomainType
domain()
The network (vpc
).String
domainAsString()
The network (vpc
).boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
instanceId()
The ID of the instance that the address is associated with (if any).String
networkBorderGroup()
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.String
networkInterfaceId()
The ID of the network interface.String
networkInterfaceOwnerId()
The ID of the Amazon Web Services account that owns the network interface.String
privateIpAddress()
The private IP address associated with the Elastic IP address.String
publicIp()
The Elastic IP address.String
publicIpv4Pool()
The ID of an address pool.List<SdkField<?>>
sdkFields()
static Class<? extends Address.Builder>
serializableBuilderClass()
List<Tag>
tags()
Any tags assigned to the Elastic IP address.Address.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
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.
-
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 returnDomainType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainAsString()
.- Returns:
- The network (
vpc
). - See Also:
DomainType
-
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 returnDomainType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainAsString()
.- Returns:
- The network (
vpc
). - See Also:
DomainType
-
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 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
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).
-
toBuilder
public Address.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Address.Builder,Address>
-
builder
public static Address.Builder builder()
-
serializableBuilderClass
public static Class<? extends Address.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-