software.amazon.awssdk.services.ec2.model

Class AllocateAddressRequest

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(value="software.amazon.awssdk:codegen")
public final class AllocateAddressRequest
extends Ec2Request
implements ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AllocateAddressRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	address() [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
static AllocateAddressRequest.Builder	builder()
DomainType	domain() Set to vpc to allocate the address for use with instances in a VPC.
String	domainAsString() Set to vpc to allocate the address for use with instances in a VPC.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	publicIpv4Pool() The ID of an address pool that you own.
List<SdkField<?>>	sdkFields()
static Class<? extends AllocateAddressRequest.Builder>	serializableBuilderClass()
AllocateAddressRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domain

public DomainType domain()

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

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:

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

See Also:

DomainType

domainAsString

public String domainAsString()

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

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:

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

See Also:

DomainType

address

public String address()

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Returns:

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

publicIpv4Pool

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

toBuilder

public AllocateAddressRequest.Builder 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 interface ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>

Specified by:

toBuilder in class Ec2Request

Returns:

a builder for type T

builder

public static AllocateAddressRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AllocateAddressRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.