Interface GetKnowledgeBaseDocumentsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRequest.Builder, Buildable, CopyableBuilder<GetKnowledgeBaseDocumentsRequest.Builder,GetKnowledgeBaseDocumentsRequest>, SdkBuilder<GetKnowledgeBaseDocumentsRequest.Builder,GetKnowledgeBaseDocumentsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetKnowledgeBaseDocumentsRequest

@Mutable
@NotThreadSafe
public static interface GetKnowledgeBaseDocumentsRequest.Builder
extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<GetKnowledgeBaseDocumentsRequest.Builder,GetKnowledgeBaseDocumentsRequest>

Method Summary

Modifier and Type	Method	Description
GetKnowledgeBaseDocumentsRequest.Builder	dataSourceId(String dataSourceId)	The unique identifier of the data source that contains the documents.
GetKnowledgeBaseDocumentsRequest.Builder	documentIdentifiers(Collection<DocumentIdentifier> documentIdentifiers)	A list of objects, each of which contains information to identify a document for which to retrieve information.
GetKnowledgeBaseDocumentsRequest.Builder	documentIdentifiers(Consumer<DocumentIdentifier.Builder>... documentIdentifiers)	A list of objects, each of which contains information to identify a document for which to retrieve information.
GetKnowledgeBaseDocumentsRequest.Builder	documentIdentifiers(DocumentIdentifier... documentIdentifiers)	A list of objects, each of which contains information to identify a document for which to retrieve information.
GetKnowledgeBaseDocumentsRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base that is connected to the data source.
GetKnowledgeBaseDocumentsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetKnowledgeBaseDocumentsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest.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

knowledgeBaseId

GetKnowledgeBaseDocumentsRequest.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base that is connected to the data source.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base that is connected to the data source.

Returns:

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

dataSourceId

GetKnowledgeBaseDocumentsRequest.Builder dataSourceId(String dataSourceId)

The unique identifier of the data source that contains the documents.

Parameters:

dataSourceId - The unique identifier of the data source that contains the documents.

Returns:

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

documentIdentifiers

GetKnowledgeBaseDocumentsRequest.Builder documentIdentifiers(Collection<DocumentIdentifier> documentIdentifiers)

A list of objects, each of which contains information to identify a document for which to retrieve information.

Parameters:

documentIdentifiers - A list of objects, each of which contains information to identify a document for which to retrieve information.

Returns:

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

documentIdentifiers

GetKnowledgeBaseDocumentsRequest.Builder documentIdentifiers(DocumentIdentifier... documentIdentifiers)

A list of objects, each of which contains information to identify a document for which to retrieve information.

Parameters:

documentIdentifiers - A list of objects, each of which contains information to identify a document for which to retrieve information.

Returns:

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

documentIdentifiers

GetKnowledgeBaseDocumentsRequest.Builder documentIdentifiers(Consumer<DocumentIdentifier.Builder>... documentIdentifiers)

A list of objects, each of which contains information to identify a document for which to retrieve information.

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

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

Parameters:

documentIdentifiers - a consumer that will call methods on DocumentIdentifier.Builder

Returns:

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

See Also:

• documentIdentifiers(java.util.Collection<DocumentIdentifier>)

overrideConfiguration

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

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