Interface KnowledgeBase.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBase

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

Method Summary

Modifier and Type	Method	Description
KnowledgeBase.Builder	createdAt(Instant createdAt)	The date and time that the knowledge base was created.
KnowledgeBase.Builder	dataSourceArn(String dataSourceArn)	The ARN of the data source associated with the knowledge base.
KnowledgeBase.Builder	description(String description)	The description of the knowledge base.
KnowledgeBase.Builder	documentCount(Long documentCount)	The number of documents in the knowledge base.
default KnowledgeBase.Builder	firstCompletedIngestionSummary(Consumer<KnowledgeBaseIngestionSummary.Builder> firstCompletedIngestionSummary)	A summary of the first completed ingestion for the knowledge base.
KnowledgeBase.Builder	firstCompletedIngestionSummary(KnowledgeBaseIngestionSummary firstCompletedIngestionSummary)	A summary of the first completed ingestion for the knowledge base.
default KnowledgeBase.Builder	firstIncompleteIngestionSummary(Consumer<KnowledgeBaseIngestionSummary.Builder> firstIncompleteIngestionSummary)	A summary of the first incomplete ingestion for the knowledge base.
KnowledgeBase.Builder	firstIncompleteIngestionSummary(KnowledgeBaseIngestionSummary firstIncompleteIngestionSummary)	A summary of the first incomplete ingestion for the knowledge base.
KnowledgeBase.Builder	isEmailNotificationOptedForIngestionFailures(Boolean isEmailNotificationOptedForIngestionFailures)	Indicates whether email notifications are enabled for ingestion failures.
KnowledgeBase.Builder	knowledgeBaseArn(String knowledgeBaseArn)	The Amazon Resource Name (ARN) of the knowledge base.
default KnowledgeBase.Builder	knowledgeBaseConfiguration(Consumer<KnowledgeBaseConfiguration.Builder> knowledgeBaseConfiguration)	The configuration settings for the knowledge base.
KnowledgeBase.Builder	knowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)	The configuration settings for the knowledge base.
KnowledgeBase.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier for the knowledge base.
KnowledgeBase.Builder	knowledgeBaseSizeBytes(Long knowledgeBaseSizeBytes)	The size of the knowledge base in bytes.
default KnowledgeBase.Builder	latestIngestionSummary(Consumer<KnowledgeBaseIngestionSummary.Builder> latestIngestionSummary)	A summary of the most recent ingestion for the knowledge base.
KnowledgeBase.Builder	latestIngestionSummary(KnowledgeBaseIngestionSummary latestIngestionSummary)	A summary of the most recent ingestion for the knowledge base.
default KnowledgeBase.Builder	mediaExtractionConfiguration(Consumer<MediaExtractionConfiguration.Builder> mediaExtractionConfiguration)	The media extraction configuration for the knowledge base.
KnowledgeBase.Builder	mediaExtractionConfiguration(MediaExtractionConfiguration mediaExtractionConfiguration)	The media extraction configuration for the knowledge base.
KnowledgeBase.Builder	name(String name)	The name of the knowledge base.
KnowledgeBase.Builder	primaryOwnerArn(String primaryOwnerArn)	The ARN of the primary owner of the knowledge base.
KnowledgeBase.Builder	primaryOwnerUsername(String primaryOwnerUsername)	The username of the primary owner of the knowledge base.
KnowledgeBase.Builder	status(String status)	The status of the knowledge base.
KnowledgeBase.Builder	status(DataSetStatus status)	The status of the knowledge base.
KnowledgeBase.Builder	type(String type)	The type of the knowledge base.
KnowledgeBase.Builder	updatedAt(Instant updatedAt)	The date and time that the knowledge base was last updated.

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

knowledgeBaseArn

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

KnowledgeBase.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier for the knowledge base.

Parameters:

knowledgeBaseId - The unique identifier for the knowledge base.

Returns:

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

name

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

status

KnowledgeBase.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:

• DataSetStatus
• DataSetStatus

status

KnowledgeBase.Builder status(DataSetStatus 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:

• DataSetStatus
• DataSetStatus

dataSourceArn

KnowledgeBase.Builder dataSourceArn(String dataSourceArn)

The ARN of the data source associated with the knowledge base.

Parameters:

dataSourceArn - The ARN of the data source associated with the knowledge base.

Returns:

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

knowledgeBaseConfiguration

KnowledgeBase.Builder knowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)

The configuration settings for the knowledge base.

Parameters:

knowledgeBaseConfiguration - The configuration settings for the knowledge base.

Returns:

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

knowledgeBaseConfiguration

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

The configuration settings for the knowledge base.

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)

mediaExtractionConfiguration

KnowledgeBase.Builder mediaExtractionConfiguration(MediaExtractionConfiguration mediaExtractionConfiguration)

The media extraction configuration for the knowledge base.

Parameters:

mediaExtractionConfiguration - The media extraction configuration for the knowledge base.

Returns:

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

mediaExtractionConfiguration

default KnowledgeBase.Builder mediaExtractionConfiguration(Consumer<MediaExtractionConfiguration.Builder> mediaExtractionConfiguration)

The media extraction configuration for the knowledge base.

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

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

Parameters:

mediaExtractionConfiguration - a consumer that will call methods on MediaExtractionConfiguration.Builder

Returns:

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

See Also:

• mediaExtractionConfiguration(MediaExtractionConfiguration)

type

KnowledgeBase.Builder type(String type)

The type of the knowledge base.

Parameters:

type - The type of the knowledge base.

Returns:

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

createdAt

KnowledgeBase.Builder createdAt(Instant createdAt)

The date and time that the knowledge base was created.

Parameters:

createdAt - The date and time that the knowledge base was created.

Returns:

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

updatedAt

KnowledgeBase.Builder updatedAt(Instant updatedAt)

The date and time that the knowledge base was last updated.

Parameters:

updatedAt - The date and time that the knowledge base was last updated.

Returns:

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

description

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

isEmailNotificationOptedForIngestionFailures

KnowledgeBase.Builder isEmailNotificationOptedForIngestionFailures(Boolean isEmailNotificationOptedForIngestionFailures)

Indicates whether email notifications are enabled for ingestion failures.

Parameters:

isEmailNotificationOptedForIngestionFailures - Indicates whether email notifications are enabled for ingestion failures.

Returns:

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

firstCompletedIngestionSummary

KnowledgeBase.Builder firstCompletedIngestionSummary(KnowledgeBaseIngestionSummary firstCompletedIngestionSummary)

A summary of the first completed ingestion for the knowledge base.

Parameters:

firstCompletedIngestionSummary - A summary of the first completed ingestion for the knowledge base.

Returns:

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

firstCompletedIngestionSummary

default KnowledgeBase.Builder firstCompletedIngestionSummary(Consumer<KnowledgeBaseIngestionSummary.Builder> firstCompletedIngestionSummary)

A summary of the first completed ingestion for the knowledge base.

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

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

Parameters:

firstCompletedIngestionSummary - a consumer that will call methods on KnowledgeBaseIngestionSummary.Builder

Returns:

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

See Also:

• firstCompletedIngestionSummary(KnowledgeBaseIngestionSummary)

firstIncompleteIngestionSummary

KnowledgeBase.Builder firstIncompleteIngestionSummary(KnowledgeBaseIngestionSummary firstIncompleteIngestionSummary)

A summary of the first incomplete ingestion for the knowledge base.

Parameters:

firstIncompleteIngestionSummary - A summary of the first incomplete ingestion for the knowledge base.

Returns:

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

firstIncompleteIngestionSummary

default KnowledgeBase.Builder firstIncompleteIngestionSummary(Consumer<KnowledgeBaseIngestionSummary.Builder> firstIncompleteIngestionSummary)

A summary of the first incomplete ingestion for the knowledge base.

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

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

Parameters:

firstIncompleteIngestionSummary - a consumer that will call methods on KnowledgeBaseIngestionSummary.Builder

Returns:

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

See Also:

• firstIncompleteIngestionSummary(KnowledgeBaseIngestionSummary)

latestIngestionSummary

KnowledgeBase.Builder latestIngestionSummary(KnowledgeBaseIngestionSummary latestIngestionSummary)

A summary of the most recent ingestion for the knowledge base.

Parameters:

latestIngestionSummary - A summary of the most recent ingestion for the knowledge base.

Returns:

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

latestIngestionSummary

default KnowledgeBase.Builder latestIngestionSummary(Consumer<KnowledgeBaseIngestionSummary.Builder> latestIngestionSummary)

A summary of the most recent ingestion for the knowledge base.

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

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

Parameters:

latestIngestionSummary - a consumer that will call methods on KnowledgeBaseIngestionSummary.Builder

Returns:

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

See Also:

• latestIngestionSummary(KnowledgeBaseIngestionSummary)

knowledgeBaseSizeBytes

KnowledgeBase.Builder knowledgeBaseSizeBytes(Long knowledgeBaseSizeBytes)

The size of the knowledge base in bytes.

Parameters:

knowledgeBaseSizeBytes - The size of the knowledge base in bytes.

Returns:

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

documentCount

KnowledgeBase.Builder documentCount(Long documentCount)

The number of documents in the knowledge base.

Parameters:

documentCount - The number of documents in the knowledge base.

Returns:

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

primaryOwnerArn

KnowledgeBase.Builder primaryOwnerArn(String primaryOwnerArn)

The ARN of the primary owner of the knowledge base.

Parameters:

primaryOwnerArn - The ARN of the primary owner of the knowledge base.

Returns:

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

primaryOwnerUsername

KnowledgeBase.Builder primaryOwnerUsername(String primaryOwnerUsername)

The username of the primary owner of the knowledge base.

Parameters:

primaryOwnerUsername - The username of the primary owner of the knowledge base.

Returns:

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