Interface RetrieveRequest.Builder

All Superinterfaces:

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

Enclosing class:

RetrieveRequest

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

Method Summary

Modifier and Type	Method	Description
RetrieveRequest.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant for content retrieval.
RetrieveRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
RetrieveRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default RetrieveRequest.Builder	retrievalConfiguration(Consumer<RetrievalConfiguration.Builder> retrievalConfiguration)	The configuration for the content retrieval operation.
RetrieveRequest.Builder	retrievalConfiguration(RetrievalConfiguration retrievalConfiguration)	The configuration for the content retrieval operation.
RetrieveRequest.Builder	retrievalQuery(String retrievalQuery)	The query for content retrieval.

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

assistantId

RetrieveRequest.Builder assistantId(String assistantId)

The identifier of the Amazon Q in Connect assistant for content retrieval.

Parameters:

assistantId - The identifier of the Amazon Q in Connect assistant for content retrieval.

Returns:

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

retrievalConfiguration

RetrieveRequest.Builder retrievalConfiguration(RetrievalConfiguration retrievalConfiguration)

The configuration for the content retrieval operation.

Parameters:

retrievalConfiguration - The configuration for the content retrieval operation.

Returns:

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

retrievalConfiguration

default RetrieveRequest.Builder retrievalConfiguration(Consumer<RetrievalConfiguration.Builder> retrievalConfiguration)

The configuration for the content retrieval operation.

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

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

Parameters:

retrievalConfiguration - a consumer that will call methods on RetrievalConfiguration.Builder

Returns:

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

See Also:

• retrievalConfiguration(RetrievalConfiguration)

retrievalQuery

RetrieveRequest.Builder retrievalQuery(String retrievalQuery)

The query for content retrieval.

Parameters:

retrievalQuery - The query for content retrieval.

Returns:

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

overrideConfiguration

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

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