Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface RetrieveRequest.Builder

All Superinterfaces:

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

Enclosing class:

RetrieveRequest

public static interface RetrieveRequest.Builder
extends BedrockAgentRuntimeRequest.Builder, SdkPojo, CopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>

Method Summary

Modifier and Type	Method	Description
RetrieveRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	Sets the value of the KnowledgeBaseId property for this object.
RetrieveRequest.Builder	nextToken(String nextToken)	Sets the value of the NextToken property for this object.
RetrieveRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
RetrieveRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default RetrieveRequest.Builder	retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)	Sets the value of the RetrievalConfiguration property for this object.
RetrieveRequest.Builder	retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)	Sets the value of the RetrievalConfiguration property for this object.
default RetrieveRequest.Builder	retrievalQuery(Consumer<KnowledgeBaseQuery.Builder> retrievalQuery)	Sets the value of the RetrievalQuery property for this object.
RetrieveRequest.Builder	retrievalQuery(KnowledgeBaseQuery retrievalQuery)	Sets the value of the RetrievalQuery property for this object.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest.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, sdkFields

Method Detail

knowledgeBaseId

RetrieveRequest.Builder knowledgeBaseId(String knowledgeBaseId)

Sets the value of the KnowledgeBaseId property for this object.

Parameters:

knowledgeBaseId - The new value for the KnowledgeBaseId property for this object.

Returns:

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

retrievalQuery

RetrieveRequest.Builder retrievalQuery(KnowledgeBaseQuery retrievalQuery)

Sets the value of the RetrievalQuery property for this object.

Parameters:

retrievalQuery - The new value for the RetrievalQuery property for this object.

Returns:

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

retrievalQuery

default RetrieveRequest.Builder retrievalQuery(Consumer<KnowledgeBaseQuery.Builder> retrievalQuery)

Sets the value of the RetrievalQuery property for this object. This is a convenience method that creates an instance of the KnowledgeBaseQuery.Builder avoiding the need to create one manually via KnowledgeBaseQuery.builder().

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

Parameters:

retrievalQuery - a consumer that will call methods on KnowledgeBaseQuery.Builder

Returns:

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

See Also:

retrievalQuery(KnowledgeBaseQuery)

retrievalConfiguration

RetrieveRequest.Builder retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

Sets the value of the RetrievalConfiguration property for this object.

Parameters:

retrievalConfiguration - The new value for the RetrievalConfiguration property for this object.

Returns:

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

retrievalConfiguration

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

Sets the value of the RetrievalConfiguration property for this object. This is a convenience method that creates an instance of the KnowledgeBaseRetrievalConfiguration.Builder avoiding the need to create one manually via KnowledgeBaseRetrievalConfiguration.builder().

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

Parameters:

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

Returns:

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

See Also:

retrievalConfiguration(KnowledgeBaseRetrievalConfiguration)

nextToken

RetrieveRequest.Builder nextToken(String nextToken)

Sets the value of the NextToken property for this object.

Parameters:

nextToken - The new value for the NextToken property for this object.

Returns:

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

overrideConfiguration

RetrieveRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

RetrieveRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder