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

Interface ListContactsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListContactsRequest.Builder,ListContactsRequest>, SdkBuilder<ListContactsRequest.Builder,ListContactsRequest>, SdkPojo, SdkRequest.Builder, SesV2Request.Builder

Enclosing class:

ListContactsRequest

@Mutable
@NotThreadSafe
public static interface ListContactsRequest.Builder
extends SesV2Request.Builder, SdkPojo, CopyableBuilder<ListContactsRequest.Builder,ListContactsRequest>

Method Summary

Modifier and Type	Method	Description
ListContactsRequest.Builder	contactListName(String contactListName)	The name of the contact list.
default ListContactsRequest.Builder	filter(Consumer<ListContactsFilter.Builder> filter)	A filter that can be applied to a list of contacts.
ListContactsRequest.Builder	filter(ListContactsFilter filter)	A filter that can be applied to a list of contacts.
ListContactsRequest.Builder	nextToken(String nextToken)	A string token indicating that there might be additional contacts available to be listed.
ListContactsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListContactsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListContactsRequest.Builder	pageSize(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.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.sesv2.model.SesV2Request.Builder

build

Method Detail

contactListName

ListContactsRequest.Builder contactListName(String contactListName)

The name of the contact list.

Parameters:

contactListName - The name of the contact list.

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

ListContactsRequest.Builder filter(ListContactsFilter filter)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

default ListContactsRequest.Builder filter(Consumer<ListContactsFilter.Builder> filter)

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

This is a convenience method that creates an instance of the ListContactsFilter.Builder avoiding the need to create one manually via ListContactsFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(ListContactsFilter).

Parameters:

filter - a consumer that will call methods on ListContactsFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

filter(ListContactsFilter)

pageSize

ListContactsRequest.Builder pageSize(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

nextToken

ListContactsRequest.Builder nextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ListContactsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListContactsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder