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.AllocateAddressRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AllocateAddressRequest
extends Ec2Request
implements ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AllocateAddressRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`address()`	The Elastic IP address to recover or an IPv4 address from an address pool.
`static AllocateAddressRequest.Builder`	`builder()`
`String`	`customerOwnedIpv4Pool()`	The ID of a customer-owned address pool.
`DomainType`	`domain()`	The network (`vpc`).
`String`	`domainAsString()`	The network (`vpc`).
`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTagSpecifications()`	For responses, this returns true if the service returned a value for the TagSpecifications property.
`String`	`networkBorderGroup()`	A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
`String`	`publicIpv4Pool()`	The ID of an address pool that you own.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AllocateAddressRequest.Builder>`	`serializableBuilderClass()`
`List<TagSpecification>`	`tagSpecifications()`	The tags to assign to the Elastic IP address.
`AllocateAddressRequest.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
  - 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:
    
    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 return DomainType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().
    
    Returns:
    
    The network (vpc).
    
    See Also:
    
    DomainType
  - address
```
public final String 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
```
public final String 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
```
public final String 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.
    
    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.
  - customerOwnedIpv4Pool
```
public final String 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
```
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 is UnauthorizedOperation.
    
    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 is UnauthorizedOperation.
  - 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 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.
  - tagSpecifications
```
public final List<TagSpecification> 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
```
public AllocateAddressRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static AllocateAddressRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AllocateAddressRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AllocateAddressRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

domain

domainAsString

address

publicIpv4Pool

networkBorderGroup

customerOwnedIpv4Pool

dryRun

hasTagSpecifications

tagSpecifications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields