Package software.amazon.awssdk.services.sesv2.model

Class ListContactsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sesv2.model.SesV2Request

software.amazon.awssdk.services.sesv2.model.ListContactsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListContactsRequest.Builder,ListContactsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListContactsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListContactsRequest.Builder	builder()
String	contactListName()	The name of the contact list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ListContactsFilter	filter()	A filter that can be applied to a list of contacts.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	nextToken()	A string token indicating that there might be additional contacts available to be listed.
Integer	pageSize()	The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListContactsRequest.Builder>	serializableBuilderClass()
ListContactsRequest.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

contactListName

public final String contactListName()

The name of the contact list.

Returns:

The name of the contact list.

filter

public final ListContactsFilter filter()

A filter that can be applied to a list of contacts.

Returns:

A filter that can be applied to a list of contacts.

pageSize

public final Integer pageSize()

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

Returns:

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

nextToken

public final String nextToken()

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Returns:

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

toBuilder

public ListContactsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListContactsRequest.Builder,ListContactsRequest>

Specified by:

toBuilder in class SesV2Request

builder

public static ListContactsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo