software.amazon.awssdk.services.alexaforbusiness.model

Interface SearchContactsRequest.Builder

All Superinterfaces:

AlexaForBusinessRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<SearchContactsRequest.Builder,SearchContactsRequest>, SdkBuilder<SearchContactsRequest.Builder,SearchContactsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchContactsRequest

public static interface SearchContactsRequest.Builder
extends AlexaForBusinessRequest.Builder, SdkPojo, CopyableBuilder<SearchContactsRequest.Builder,SearchContactsRequest>

Method Summary

Modifier and Type	Method and Description
SearchContactsRequest.Builder	filters(Collection<Filter> filters) The filters to use to list a specified set of address books.
SearchContactsRequest.Builder	filters(Consumer<Filter.Builder>... filters) The filters to use to list a specified set of address books.
SearchContactsRequest.Builder	filters(Filter... filters) The filters to use to list a specified set of address books.
SearchContactsRequest.Builder	maxResults(Integer maxResults) The maximum number of results to include in the response.
SearchContactsRequest.Builder	nextToken(String nextToken) An optional token returned from a prior request.
SearchContactsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
SearchContactsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
SearchContactsRequest.Builder	sortCriteria(Collection<Sort> sortCriteria) The sort order to use in listing the specified set of contacts.
SearchContactsRequest.Builder	sortCriteria(Consumer<Sort.Builder>... sortCriteria) The sort order to use in listing the specified set of contacts.
SearchContactsRequest.Builder	sortCriteria(Sort... sortCriteria) The sort order to use in listing the specified set of contacts.

Methods inherited from interface software.amazon.awssdk.services.alexaforbusiness.model.AlexaForBusinessRequest.Builder

build

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

overrideConfiguration

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

sdkFields

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

copy

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

applyMutation, build

Method Detail

filters

SearchContactsRequest.Builder filters(Collection<Filter> filters)

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Parameters:

filters - The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Returns:

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

filters

SearchContactsRequest.Builder filters(Filter... filters)

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Parameters:

filters - The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Returns:

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

filters

SearchContactsRequest.Builder filters(Consumer<Filter.Builder>... filters)

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

sortCriteria

SearchContactsRequest.Builder sortCriteria(Collection<Sort> sortCriteria)

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Parameters:

sortCriteria - The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Returns:

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

sortCriteria

SearchContactsRequest.Builder sortCriteria(Sort... sortCriteria)

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Parameters:

sortCriteria - The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Returns:

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

sortCriteria

SearchContactsRequest.Builder sortCriteria(Consumer<Sort.Builder>... sortCriteria)

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #sortCriteria(List).

Parameters:

sortCriteria - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#sortCriteria(List)

nextToken

SearchContactsRequest.Builder nextToken(String nextToken)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Parameters:

nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Returns:

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

maxResults

SearchContactsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Parameters:

maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Returns:

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

overrideConfiguration

SearchContactsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.