Interface SearchQueuesRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchQueuesRequest

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

Method Summary

Modifier and Type	Method	Description
SearchQueuesRequest.Builder	instanceId(String instanceId)	The identifier of the Amazon Connect instance.
SearchQueuesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchQueuesRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchQueuesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchQueuesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchQueuesRequest.Builder	searchCriteria(Consumer<QueueSearchCriteria.Builder> searchCriteria)	The search criteria to be used to return queues.
SearchQueuesRequest.Builder	searchCriteria(QueueSearchCriteria searchCriteria)	The search criteria to be used to return queues.
default SearchQueuesRequest.Builder	searchFilter(Consumer<QueueSearchFilter.Builder> searchFilter)	Filters to be applied to search results.
SearchQueuesRequest.Builder	searchFilter(QueueSearchFilter searchFilter)	Filters to be applied 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

SearchQueuesRequest.Builder instanceId(String instanceId)

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

Parameters:

instanceId - The identifier of the 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.

nextToken

SearchQueuesRequest.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.

maxResults

SearchQueuesRequest.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.

searchFilter

SearchQueuesRequest.Builder searchFilter(QueueSearchFilter searchFilter)

Filters to be applied to search results.

Parameters:

searchFilter - Filters to be applied to search results.

Returns:

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

searchFilter

default SearchQueuesRequest.Builder searchFilter(Consumer<QueueSearchFilter.Builder> searchFilter)

Filters to be applied to search results.

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

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

Parameters:

searchFilter - a consumer that will call methods on QueueSearchFilter.Builder

Returns:

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

See Also:

• searchFilter(QueueSearchFilter)

searchCriteria

SearchQueuesRequest.Builder searchCriteria(QueueSearchCriteria searchCriteria)

The search criteria to be used to return queues.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Parameters:

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

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Returns:

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

searchCriteria

default SearchQueuesRequest.Builder searchCriteria(Consumer<QueueSearchCriteria.Builder> searchCriteria)

The search criteria to be used to return queues.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

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

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

Parameters:

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

Returns:

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

See Also:

• searchCriteria(QueueSearchCriteria)

overrideConfiguration

SearchQueuesRequest.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

SearchQueuesRequest.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.