Interface UpdateKnowledgeBaseRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateKnowledgeBaseRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateKnowledgeBaseRequest.Builder	description(String description)	Specifies a new description for the knowledge base.
default UpdateKnowledgeBaseRequest.Builder	knowledgeBaseConfiguration(Consumer<KnowledgeBaseConfiguration.Builder> knowledgeBaseConfiguration)	Specifies the configuration for the embeddings model used for the knowledge base.
UpdateKnowledgeBaseRequest.Builder	knowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)	Specifies the configuration for the embeddings model used for the knowledge base.
UpdateKnowledgeBaseRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base to update.
UpdateKnowledgeBaseRequest.Builder	name(String name)	Specifies a new name for the knowledge base.
UpdateKnowledgeBaseRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateKnowledgeBaseRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateKnowledgeBaseRequest.Builder	roleArn(String roleArn)	Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
default UpdateKnowledgeBaseRequest.Builder	storageConfiguration(Consumer<StorageConfiguration.Builder> storageConfiguration)	Specifies the configuration for the vector store used for the knowledge base.
UpdateKnowledgeBaseRequest.Builder	storageConfiguration(StorageConfiguration storageConfiguration)	Specifies the configuration for the vector store used for the knowledge base.

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

description

UpdateKnowledgeBaseRequest.Builder description(String description)

Specifies a new description for the knowledge base.

Parameters:

description - Specifies a new description for the knowledge base.

Returns:

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

knowledgeBaseConfiguration

UpdateKnowledgeBaseRequest.Builder knowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)

Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

Parameters:

knowledgeBaseConfiguration - Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

Returns:

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

knowledgeBaseConfiguration

default UpdateKnowledgeBaseRequest.Builder knowledgeBaseConfiguration(Consumer<KnowledgeBaseConfiguration.Builder> knowledgeBaseConfiguration)

Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

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

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

Parameters:

knowledgeBaseConfiguration - a consumer that will call methods on KnowledgeBaseConfiguration.Builder

Returns:

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

See Also:

• knowledgeBaseConfiguration(KnowledgeBaseConfiguration)

knowledgeBaseId

UpdateKnowledgeBaseRequest.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base to update.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base to update.

Returns:

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

name

UpdateKnowledgeBaseRequest.Builder name(String name)

Specifies a new name for the knowledge base.

Parameters:

name - Specifies a new name for the knowledge base.

Returns:

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

roleArn

UpdateKnowledgeBaseRequest.Builder roleArn(String roleArn)

Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

Parameters:

roleArn - Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

Returns:

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

storageConfiguration

UpdateKnowledgeBaseRequest.Builder storageConfiguration(StorageConfiguration storageConfiguration)

Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

Parameters:

storageConfiguration - Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

Returns:

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

storageConfiguration

default UpdateKnowledgeBaseRequest.Builder storageConfiguration(Consumer<StorageConfiguration.Builder> storageConfiguration)

Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

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

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

Parameters:

storageConfiguration - a consumer that will call methods on StorageConfiguration.Builder

Returns:

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

See Also:

• storageConfiguration(StorageConfiguration)

overrideConfiguration

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

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