Interface SearchContactsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchContactsRequest

@Mutable
@NotThreadSafe
public static interface SearchContactsRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<SearchContactsRequest.Builder,SearchContactsRequest>

Method Summary

Modifier and Type	Method	Description
SearchContactsRequest.Builder	instanceId(String instanceId)	The identifier of Amazon Connect instance.
SearchContactsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchContactsRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchContactsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchContactsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchContactsRequest.Builder	searchCriteria(Consumer<SearchCriteria.Builder> searchCriteria)	The search criteria to be used to return contacts.
SearchContactsRequest.Builder	searchCriteria(SearchCriteria searchCriteria)	The search criteria to be used to return contacts.
default SearchContactsRequest.Builder	sort(Consumer<Sort.Builder> sort)	Specifies a field to sort by and a sort order.
SearchContactsRequest.Builder	sort(Sort sort)	Specifies a field to sort by and a sort order.
default SearchContactsRequest.Builder	timeRange(Consumer<SearchContactsTimeRange.Builder> timeRange)	Time range that you want to search results.
SearchContactsRequest.Builder	timeRange(SearchContactsTimeRange timeRange)	Time range that you want to search results.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

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

Method Details

instanceId

SearchContactsRequest.Builder instanceId(String instanceId)

The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

timeRange

SearchContactsRequest.Builder timeRange(SearchContactsTimeRange timeRange)

Time range that you want to search results.

Parameters:

timeRange - Time range that you want to search results.

Returns:

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

timeRange

default SearchContactsRequest.Builder timeRange(Consumer<SearchContactsTimeRange.Builder> timeRange)

Time range that you want to search results.

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

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

Parameters:

timeRange - a consumer that will call methods on SearchContactsTimeRange.Builder

Returns:

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

See Also:

• timeRange(SearchContactsTimeRange)

searchCriteria

SearchContactsRequest.Builder searchCriteria(SearchCriteria searchCriteria)

The search criteria to be used to return contacts.

Parameters:

searchCriteria - The search criteria to be used to return contacts.

Returns:

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

searchCriteria

default SearchContactsRequest.Builder searchCriteria(Consumer<SearchCriteria.Builder> searchCriteria)

The search criteria to be used to return contacts.

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

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

Parameters:

searchCriteria - a consumer that will call methods on SearchCriteria.Builder

Returns:

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

See Also:

• searchCriteria(SearchCriteria)

maxResults

SearchContactsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

Returns:

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

nextToken

SearchContactsRequest.Builder nextToken(String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Parameters:

nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

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

sort

SearchContactsRequest.Builder sort(Sort sort)

Specifies a field to sort by and a sort order.

Parameters:

sort - Specifies a field to sort by and a sort order.

Returns:

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

sort

default SearchContactsRequest.Builder sort(Consumer<Sort.Builder> sort)

Specifies a field to sort by and a sort order.

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

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

Parameters:

sort - a consumer that will call methods on Sort.Builder

Returns:

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

See Also:

• sort(Sort)

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.