Interface KnowledgeBaseData.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseData

public static interface KnowledgeBaseData.Builder
extends SdkPojo, CopyableBuilder<KnowledgeBaseData.Builder,KnowledgeBaseData>

Method Summary

Modifier and Type	Method	Description
KnowledgeBaseData.Builder	description(String description)	The description.
KnowledgeBaseData.Builder	ingestionFailureReasons(String... ingestionFailureReasons)	List of failure reasons on ingestion per file.
KnowledgeBaseData.Builder	ingestionFailureReasons(Collection<String> ingestionFailureReasons)	List of failure reasons on ingestion per file.
KnowledgeBaseData.Builder	ingestionStatus(String ingestionStatus)	Status of ingestion on data source.
KnowledgeBaseData.Builder	ingestionStatus(SyncStatus ingestionStatus)	Status of ingestion on data source.
KnowledgeBaseData.Builder	knowledgeBaseArn(String knowledgeBaseArn)	The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseData.Builder	knowledgeBaseId(String knowledgeBaseId)	The identifier of the knowledge base.
KnowledgeBaseData.Builder	knowledgeBaseType(String knowledgeBaseType)	The type of knowledge base.
KnowledgeBaseData.Builder	knowledgeBaseType(KnowledgeBaseType knowledgeBaseType)	The type of knowledge base.
KnowledgeBaseData.Builder	lastContentModificationTime(Instant lastContentModificationTime)	An epoch timestamp indicating the most recent content modification inside the knowledge base.
KnowledgeBaseData.Builder	name(String name)	The name of the knowledge base.
default KnowledgeBaseData.Builder	renderingConfiguration(Consumer<RenderingConfiguration.Builder> renderingConfiguration)	Information about how to render the content.
KnowledgeBaseData.Builder	renderingConfiguration(RenderingConfiguration renderingConfiguration)	Information about how to render the content.
default KnowledgeBaseData.Builder	serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)	The configuration information for the customer managed key used for encryption.
KnowledgeBaseData.Builder	serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)	The configuration information for the customer managed key used for encryption.
default KnowledgeBaseData.Builder	sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration)	Source configuration information about the knowledge base.
KnowledgeBaseData.Builder	sourceConfiguration(SourceConfiguration sourceConfiguration)	Source configuration information about the knowledge base.
KnowledgeBaseData.Builder	status(String status)	The status of the knowledge base.
KnowledgeBaseData.Builder	status(KnowledgeBaseStatus status)	The status of the knowledge base.
KnowledgeBaseData.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
default KnowledgeBaseData.Builder	vectorIngestionConfiguration(Consumer<VectorIngestionConfiguration.Builder> vectorIngestionConfiguration)	Contains details about how to ingest the documents in a data source.
KnowledgeBaseData.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, sdkFields

Method Details

description

KnowledgeBaseData.Builder description(String description)

The description.

Parameters:

description - The description.

Returns:

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

ingestionFailureReasons

KnowledgeBaseData.Builder ingestionFailureReasons(Collection<String> ingestionFailureReasons)

List of failure reasons on ingestion per file.

Parameters:

ingestionFailureReasons - List of failure reasons on ingestion per file.

Returns:

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

ingestionFailureReasons

KnowledgeBaseData.Builder ingestionFailureReasons(String... ingestionFailureReasons)

List of failure reasons on ingestion per file.

Parameters:

ingestionFailureReasons - List of failure reasons on ingestion per file.

Returns:

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

ingestionStatus

KnowledgeBaseData.Builder ingestionStatus(String ingestionStatus)

Status of ingestion on data source.

Parameters:

ingestionStatus - Status of ingestion on data source.

Returns:

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

See Also:

• SyncStatus
• SyncStatus

ingestionStatus

KnowledgeBaseData.Builder ingestionStatus(SyncStatus ingestionStatus)

Status of ingestion on data source.

Parameters:

ingestionStatus - Status of ingestion on data source.

Returns:

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

See Also:

• SyncStatus
• SyncStatus

knowledgeBaseArn

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

knowledgeBaseId

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

knowledgeBaseType

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

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

lastContentModificationTime

KnowledgeBaseData.Builder lastContentModificationTime(Instant lastContentModificationTime)

An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

Parameters:

lastContentModificationTime - An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

Returns:

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

name

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

renderingConfiguration

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

KnowledgeBaseData.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 KnowledgeBaseData.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)

sourceConfiguration

KnowledgeBaseData.Builder sourceConfiguration(SourceConfiguration sourceConfiguration)

Source configuration information about the knowledge base.

Parameters:

sourceConfiguration - Source configuration information about the knowledge base.

Returns:

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

sourceConfiguration

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

Source configuration information about the knowledge base.

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)

status

KnowledgeBaseData.Builder status(String status)

The status of the knowledge base.

Parameters:

status - The status of the knowledge base.

Returns:

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

See Also:

• KnowledgeBaseStatus
• KnowledgeBaseStatus

status

KnowledgeBaseData.Builder status(KnowledgeBaseStatus status)

The status of the knowledge base.

Parameters:

status - The status of the knowledge base.

Returns:

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

See Also:

• KnowledgeBaseStatus
• KnowledgeBaseStatus

tags

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

vectorIngestionConfiguration

KnowledgeBaseData.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 KnowledgeBaseData.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)