Class AllocateAddressRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AllocateAddressRequest.Builder,
AllocateAddressRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
address()
The Elastic IP address to recover or an IPv4 address from an address pool.builder()
final String
The ID of a customer-owned address pool.final DomainType
domain()
The network (vpc
).final String
The network (vpc
).final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TagSpecifications property.final String
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.final String
The ID of an address pool that you own.static Class
<? extends AllocateAddressRequest.Builder> final List
<TagSpecification> The tags to assign 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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
-
address
The Elastic IP address to recover or an IPv4 address from an address pool.
- Returns:
- The Elastic IP address to recover or an IPv4 address from an address pool.
-
publicIpv4Pool
The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the
Address
parameter instead.- Returns:
- The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the
address pool. To specify a specific address from the address pool, use the
Address
parameter instead.
-
networkBorderGroup
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
- Returns:
- A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot
move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
-
customerOwnedIpv4Pool
The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.
- Returns:
- The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.
-
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
.
-
hasTagSpecifications
public final boolean hasTagSpecifications()For responses, this returns true if the service returned a value for the TagSpecifications 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. -
tagSpecifications
The tags to assign 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
hasTagSpecifications()
method.- Returns:
- The tags to assign to the Elastic IP address.
-
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<AllocateAddressRequest.Builder,
AllocateAddressRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-