Interface KnowledgeBaseSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<KnowledgeBaseSummary.Builder,KnowledgeBaseSummary>, SdkBuilder<KnowledgeBaseSummary.Builder,KnowledgeBaseSummary>, SdkPojo

Enclosing class:

KnowledgeBaseSummary

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

Method Summary

Modifier and Type	Method	Description
KnowledgeBaseSummary.Builder	description(String description)	The description of the knowledge base.
KnowledgeBaseSummary.Builder	knowledgeBaseArn(String knowledgeBaseArn)	The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseSummary.Builder	knowledgeBaseId(String knowledgeBaseId)	The identifier of the knowledge base.
KnowledgeBaseSummary.Builder	knowledgeBaseType(String knowledgeBaseType)	The type of knowledge base.
KnowledgeBaseSummary.Builder	knowledgeBaseType(KnowledgeBaseType knowledgeBaseType)	The type of knowledge base.
KnowledgeBaseSummary.Builder	name(String name)	The name of the knowledge base.
default KnowledgeBaseSummary.Builder	renderingConfiguration(Consumer<RenderingConfiguration.Builder> renderingConfiguration)	Information about how to render the content.
KnowledgeBaseSummary.Builder	renderingConfiguration(RenderingConfiguration renderingConfiguration)	Information about how to render the content.
default KnowledgeBaseSummary.Builder	serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)	The configuration information for the customer managed key used for encryption.
KnowledgeBaseSummary.Builder	serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)	The configuration information for the customer managed key used for encryption.
default KnowledgeBaseSummary.Builder	sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration)	Configuration information about the external data source.
KnowledgeBaseSummary.Builder	sourceConfiguration(SourceConfiguration sourceConfiguration)	Configuration information about the external data source.
KnowledgeBaseSummary.Builder	status(String status)	The status of the knowledge base summary.
KnowledgeBaseSummary.Builder	status(KnowledgeBaseStatus status)	The status of the knowledge base summary.
KnowledgeBaseSummary.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
default KnowledgeBaseSummary.Builder	vectorIngestionConfiguration(Consumer<VectorIngestionConfiguration.Builder> vectorIngestionConfiguration)	Contains details about how to ingest the documents in a data source.
KnowledgeBaseSummary.Builder	vectorIngestionConfiguration(VectorIngestionConfiguration vectorIngestionConfiguration)	Contains details about how to ingest the documents in a data source.

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

KnowledgeBaseSummary.Builder knowledgeBaseId(String knowledgeBaseId)

The identifier of the knowledge base.

Parameters:

knowledgeBaseId - The identifier of the knowledge base.

Returns:

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

knowledgeBaseArn

KnowledgeBaseSummary.Builder knowledgeBaseArn(String knowledgeBaseArn)

The Amazon Resource Name (ARN) of the knowledge base.

Parameters:

knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.

Returns:

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

name

KnowledgeBaseSummary.Builder name(String name)

The name of the knowledge base.

Parameters:

name - The name of the knowledge base.

Returns:

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

knowledgeBaseType

KnowledgeBaseSummary.Builder knowledgeBaseType(String knowledgeBaseType)

The type of knowledge base.

Parameters:

knowledgeBaseType - The type of knowledge base.

Returns:

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

See Also:

• KnowledgeBaseType
• KnowledgeBaseType

knowledgeBaseType

KnowledgeBaseSummary.Builder knowledgeBaseType(KnowledgeBaseType knowledgeBaseType)

The type of knowledge base.

Parameters:

knowledgeBaseType - The type of knowledge base.

Returns:

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

See Also:

• KnowledgeBaseType
• KnowledgeBaseType

status

KnowledgeBaseSummary.Builder status(String status)

The status of the knowledge base summary.

Parameters:

status - The status of the knowledge base summary.

Returns:

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

See Also:

• KnowledgeBaseStatus
• KnowledgeBaseStatus

status

KnowledgeBaseSummary.Builder status(KnowledgeBaseStatus status)

The status of the knowledge base summary.

Parameters:

status - The status of the knowledge base summary.

Returns:

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

See Also:

• KnowledgeBaseStatus
• KnowledgeBaseStatus

sourceConfiguration

KnowledgeBaseSummary.Builder sourceConfiguration(SourceConfiguration sourceConfiguration)

Configuration information about the external data source.

Parameters:

sourceConfiguration - Configuration information about the external data source.

Returns:

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

sourceConfiguration

default KnowledgeBaseSummary.Builder sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration)

Configuration information about the external data source.

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

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

Parameters:

sourceConfiguration - a consumer that will call methods on SourceConfiguration.Builder

Returns:

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

See Also:

• sourceConfiguration(SourceConfiguration)

vectorIngestionConfiguration

KnowledgeBaseSummary.Builder vectorIngestionConfiguration(VectorIngestionConfiguration vectorIngestionConfiguration)

Contains details about how to ingest the documents in a data source.

Parameters:

vectorIngestionConfiguration - Contains details about how to ingest the documents in a data source.

Returns:

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

vectorIngestionConfiguration

default KnowledgeBaseSummary.Builder vectorIngestionConfiguration(Consumer<VectorIngestionConfiguration.Builder> vectorIngestionConfiguration)

Contains details about how to ingest the documents in a data source.

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

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

Parameters:

vectorIngestionConfiguration - a consumer that will call methods on VectorIngestionConfiguration.Builder

Returns:

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

See Also:

• vectorIngestionConfiguration(VectorIngestionConfiguration)

renderingConfiguration

KnowledgeBaseSummary.Builder renderingConfiguration(RenderingConfiguration renderingConfiguration)

Information about how to render the content.

Parameters:

renderingConfiguration - Information about how to render the content.

Returns:

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

renderingConfiguration

default KnowledgeBaseSummary.Builder renderingConfiguration(Consumer<RenderingConfiguration.Builder> renderingConfiguration)

Information about how to render the content.

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

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

Parameters:

renderingConfiguration - a consumer that will call methods on RenderingConfiguration.Builder

Returns:

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

See Also:

• renderingConfiguration(RenderingConfiguration)

serverSideEncryptionConfiguration

KnowledgeBaseSummary.Builder serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Parameters:

serverSideEncryptionConfiguration - The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Returns:

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

serverSideEncryptionConfiguration

default KnowledgeBaseSummary.Builder serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

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

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

Parameters:

serverSideEncryptionConfiguration - a consumer that will call methods on ServerSideEncryptionConfiguration.Builder

Returns:

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

See Also:

• serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration)

description

KnowledgeBaseSummary.Builder description(String description)

The description of the knowledge base.

Parameters:

description - The description of the knowledge base.

Returns:

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

tags

KnowledgeBaseSummary.Builder tags(Map<String,String> tags)

The tags used to organize, track, or control access for this resource.

Parameters:

tags - The tags used to organize, track, or control access for this resource.

Returns:

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