Interface DeleteKnowledgeBaseDocumentsRequest.Builder

All Superinterfaces:

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

Enclosing class:

DeleteKnowledgeBaseDocumentsRequest

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

Method Summary

Modifier and Type	Method	Description
DeleteKnowledgeBaseDocumentsRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
DeleteKnowledgeBaseDocumentsRequest.Builder	dataSourceId(String dataSourceId)	The unique identifier of the data source that contains the documents.
DeleteKnowledgeBaseDocumentsRequest.Builder	documentIdentifiers(Collection<DocumentIdentifier> documentIdentifiers)	A list of objects, each of which contains information to identify a document to delete.
DeleteKnowledgeBaseDocumentsRequest.Builder	documentIdentifiers(Consumer<DocumentIdentifier.Builder>... documentIdentifiers)	A list of objects, each of which contains information to identify a document to delete.
DeleteKnowledgeBaseDocumentsRequest.Builder	documentIdentifiers(DocumentIdentifier... documentIdentifiers)	A list of objects, each of which contains information to identify a document to delete.
DeleteKnowledgeBaseDocumentsRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base that is connected to the data source.
DeleteKnowledgeBaseDocumentsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DeleteKnowledgeBaseDocumentsRequest.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

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

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

clientToken

DeleteKnowledgeBaseDocumentsRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Parameters:

clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

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

documentIdentifiers

DeleteKnowledgeBaseDocumentsRequest.Builder documentIdentifiers(Collection<DocumentIdentifier> documentIdentifiers)

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

Parameters:

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

Returns:

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

documentIdentifiers

DeleteKnowledgeBaseDocumentsRequest.Builder documentIdentifiers(DocumentIdentifier... documentIdentifiers)

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

Parameters:

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

Returns:

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

documentIdentifiers

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

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

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

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

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