Interface SearchQuickResponsesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchQuickResponsesRequest.Builder,SearchQuickResponsesRequest>, QConnectRequest.Builder, SdkBuilder<SearchQuickResponsesRequest.Builder,SearchQuickResponsesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchQuickResponsesRequest

@Mutable
@NotThreadSafe
public static interface SearchQuickResponsesRequest.Builder
extends QConnectRequest.Builder, SdkPojo, CopyableBuilder<SearchQuickResponsesRequest.Builder,SearchQuickResponsesRequest>

Method Summary

Modifier and Type	Method	Description
SearchQuickResponsesRequest.Builder	attributes(Map<String,String> attributes)	The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
SearchQuickResponsesRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	The identifier of the knowledge base.
SearchQuickResponsesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchQuickResponsesRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchQuickResponsesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchQuickResponsesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchQuickResponsesRequest.Builder	searchExpression(Consumer<QuickResponseSearchExpression.Builder> searchExpression)	The search expression for querying the quick response.
SearchQuickResponsesRequest.Builder	searchExpression(QuickResponseSearchExpression searchExpression)	The search expression for querying the quick response.

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.services.qconnect.model.QConnectRequest.Builder

build

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

knowledgeBaseId

SearchQuickResponsesRequest.Builder knowledgeBaseId(String knowledgeBaseId)

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Parameters:

knowledgeBaseId - The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

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

searchExpression

SearchQuickResponsesRequest.Builder searchExpression(QuickResponseSearchExpression searchExpression)

The search expression for querying the quick response.

Parameters:

searchExpression - The search expression for querying the quick response.

Returns:

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

searchExpression

default SearchQuickResponsesRequest.Builder searchExpression(Consumer<QuickResponseSearchExpression.Builder> searchExpression)

The search expression for querying the quick response.

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

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

Parameters:

searchExpression - a consumer that will call methods on QuickResponseSearchExpression.Builder

Returns:

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

See Also:

• searchExpression(QuickResponseSearchExpression)

nextToken

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

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

attributes

SearchQuickResponsesRequest.Builder attributes(Map<String,String> attributes)

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

Parameters:

attributes - The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

Returns:

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

overrideConfiguration

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

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