software.amazon.awssdk.services.pinpointemail.model

Class GetDedicatedIpsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pinpointemail.model.PinpointEmailRequest

software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDedicatedIpsRequest.Builder,GetDedicatedIpsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDedicatedIpsRequest
extends PinpointEmailRequest
implements ToCopyableBuilder<GetDedicatedIpsRequest.Builder,GetDedicatedIpsRequest>

A request to obtain more information about dedicated IP pools.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDedicatedIpsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetDedicatedIpsRequest.Builder	builder()
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	nextToken() A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.
Integer	pageSize() The number of results to show in a single call to GetDedicatedIpsRequest.
String	poolName() The name of the IP pool that the dedicated IP address is associated with.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDedicatedIpsRequest.Builder>	serializableBuilderClass()
GetDedicatedIpsRequest.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

poolName

public String poolName()

The name of the IP pool that the dedicated IP address is associated with.

Returns:

The name of the IP pool that the dedicated IP address is associated with.

nextToken

public String nextToken()

A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

Returns:

A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

pageSize

public Integer pageSize()

The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Returns:

The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

toBuilder

public GetDedicatedIpsRequest.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<GetDedicatedIpsRequest.Builder,GetDedicatedIpsRequest>

Specified by:

toBuilder in class PinpointEmailRequest

Returns:

a builder for type T

builder

public static GetDedicatedIpsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDedicatedIpsRequest.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.