Package software.amazon.awssdk.services.qconnect.model

Interface QueryAssistantRequest.Builder

All Superinterfaces:

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

Enclosing class:

QueryAssistantRequest

public static interface QueryAssistantRequest.Builder
extends QConnectRequest.Builder, SdkPojo, CopyableBuilder<QueryAssistantRequest.Builder,QueryAssistantRequest>

Method Summary

Modifier and Type	Method	Description
QueryAssistantRequest.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant.
QueryAssistantRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
QueryAssistantRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
QueryAssistantRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
QueryAssistantRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
QueryAssistantRequest.Builder	queryCondition(Collection<QueryCondition> queryCondition)	Information about how to query content.
QueryAssistantRequest.Builder	queryCondition(Consumer<QueryCondition.Builder>... queryCondition)	Information about how to query content.
QueryAssistantRequest.Builder	queryCondition(QueryCondition... queryCondition)	Information about how to query content.
QueryAssistantRequest.Builder	queryText(String queryText)	The text to search for.
QueryAssistantRequest.Builder	sessionId(String sessionId)	The identifier of the Amazon Q in Connect session.

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, sdkFields

Method Details

assistantId

QueryAssistantRequest.Builder assistantId(String assistantId)

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Parameters:

assistantId - The identifier of the Amazon Q in Connect assistant. 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.

maxResults

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

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

queryCondition

QueryAssistantRequest.Builder queryCondition(Collection<QueryCondition> queryCondition)

Information about how to query content.

Parameters:

queryCondition - Information about how to query content.

Returns:

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

queryCondition

QueryAssistantRequest.Builder queryCondition(QueryCondition... queryCondition)

Information about how to query content.

Parameters:

queryCondition - Information about how to query content.

Returns:

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

queryCondition

QueryAssistantRequest.Builder queryCondition(Consumer<QueryCondition.Builder>... queryCondition)

Information about how to query content.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryCondition(List<QueryCondition>).

Parameters:

queryCondition - a consumer that will call methods on QueryCondition.Builder

Returns:

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

See Also:

• queryCondition(java.util.Collection<QueryCondition>)

queryText

QueryAssistantRequest.Builder queryText(String queryText)

The text to search for.

Parameters:

queryText - The text to search for.

Returns:

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

sessionId

QueryAssistantRequest.Builder sessionId(String sessionId)

The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Parameters:

sessionId - The identifier of the Amazon Q in Connect session. 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.

overrideConfiguration

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

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