Interface SearchPromptsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchPromptsRequest

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

Method Summary

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

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

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

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

SearchPromptsRequest.Builder searchFilter(PromptSearchFilter 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 SearchPromptsRequest.Builder searchFilter(Consumer<PromptSearchFilter.Builder> searchFilter)

Filters to be applied to search results.

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

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

Parameters:

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

Returns:

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

See Also:

• searchFilter(PromptSearchFilter)

searchCriteria

SearchPromptsRequest.Builder searchCriteria(PromptSearchCriteria searchCriteria)

The search criteria to be used to return prompts.

Parameters:

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

Returns:

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

searchCriteria

default SearchPromptsRequest.Builder searchCriteria(Consumer<PromptSearchCriteria.Builder> searchCriteria)

The search criteria to be used to return prompts.

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

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

Parameters:

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

Returns:

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

See Also:

• searchCriteria(PromptSearchCriteria)

overrideConfiguration

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

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