Class DescribeAddressesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeAddressesRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeAddressesRequest.Builder,DescribeAddressesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAddressesRequest extends Ec2Request implements ToCopyableBuilder<DescribeAddressesRequest.Builder,DescribeAddressesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeAddressesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
allocationIds()
Information about the allocation IDs.static DescribeAddressesRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
One or more filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAllocationIds()
For responses, this returns true if the service returned a value for the AllocationIds property.boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasPublicIps()
For responses, this returns true if the service returned a value for the PublicIps property.List<String>
publicIps()
One or more Elastic IP addresses.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeAddressesRequest.Builder>
serializableBuilderClass()
DescribeAddressesRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters 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.
-
filters
public final List<Filter> filters()
One or more filters. Filter names and values are case-sensitive.
-
allocation-id
- The allocation ID for the address. -
association-id
- The association ID for the address. -
instance-id
- The ID of the instance the address is associated with, if any. -
network-border-group
- A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses. -
network-interface-id
- The ID of the network interface that the address is associated with, if any. -
network-interface-owner-id
- The Amazon Web Services account ID of the owner. -
private-ip-address
- The private IP address associated with the Elastic IP address. -
public-ip
- The Elastic IP address, or the carrier IP address. -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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
hasFilters()
method.- Returns:
- One or more filters. Filter names and values are case-sensitive.
-
allocation-id
- The allocation ID for the address. -
association-id
- The association ID for the address. -
instance-id
- The ID of the instance the address is associated with, if any. -
network-border-group
- A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses. -
network-interface-id
- The ID of the network interface that the address is associated with, if any. -
network-interface-owner-id
- The Amazon Web Services account ID of the owner. -
private-ip-address
- The private IP address associated with the Elastic IP address. -
public-ip
- The Elastic IP address, or the carrier IP address. -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
-
-
-
hasPublicIps
public final boolean hasPublicIps()
For responses, this returns true if the service returned a value for the PublicIps 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.
-
publicIps
public final List<String> publicIps()
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
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
hasPublicIps()
method.- Returns:
- One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
-
hasAllocationIds
public final boolean hasAllocationIds()
For responses, this returns true if the service returned a value for the AllocationIds 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.
-
allocationIds
public final List<String> allocationIds()
Information about the allocation IDs.
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
hasAllocationIds()
method.- Returns:
- Information about the allocation IDs.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
toBuilder
public DescribeAddressesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeAddressesRequest.Builder,DescribeAddressesRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeAddressesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeAddressesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-