Interface KnowledgeBaseDocumentDetail.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseDocumentDetail

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

Method Summary

Modifier and Type	Method	Description
KnowledgeBaseDocumentDetail.Builder	dataSourceId(String dataSourceId)	The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
default KnowledgeBaseDocumentDetail.Builder	identifier(Consumer<DocumentIdentifier.Builder> identifier)	Contains information that identifies the document.
KnowledgeBaseDocumentDetail.Builder	identifier(DocumentIdentifier identifier)	Contains information that identifies the document.
KnowledgeBaseDocumentDetail.Builder	knowledgeBaseId(String knowledgeBaseId)	The identifier of the knowledge base that the document was ingested into or deleted from.
KnowledgeBaseDocumentDetail.Builder	status(String status)	The ingestion status of the document.
KnowledgeBaseDocumentDetail.Builder	status(DocumentStatus status)	The ingestion status of the document.
KnowledgeBaseDocumentDetail.Builder	statusReason(String statusReason)	The reason for the status.
KnowledgeBaseDocumentDetail.Builder	updatedAt(Instant updatedAt)	The date and time at which the document 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

dataSourceId

KnowledgeBaseDocumentDetail.Builder dataSourceId(String dataSourceId)

The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.

Parameters:

dataSourceId - The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.

Returns:

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

identifier

KnowledgeBaseDocumentDetail.Builder identifier(DocumentIdentifier identifier)

Contains information that identifies the document.

Parameters:

identifier - Contains information that identifies the document.

Returns:

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

identifier

default KnowledgeBaseDocumentDetail.Builder identifier(Consumer<DocumentIdentifier.Builder> identifier)

Contains information that identifies the document.

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 identifier(DocumentIdentifier).

Parameters:

identifier - 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:

• identifier(DocumentIdentifier)

knowledgeBaseId

KnowledgeBaseDocumentDetail.Builder knowledgeBaseId(String knowledgeBaseId)

The identifier of the knowledge base that the document was ingested into or deleted from.

Parameters:

knowledgeBaseId - The identifier of the knowledge base that the document was ingested into or deleted from.

Returns:

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

status

KnowledgeBaseDocumentDetail.Builder status(String status)

The ingestion status of the document. The following statuses are possible:

• STARTED – You submitted the ingestion job containing the document.

• PENDING – The document is waiting to be ingested.

• IN_PROGRESS – The document is being ingested.

• INDEXED – The document was successfully indexed.

• PARTIALLY_INDEXED – The document was partially indexed.

• METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

• METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

• FAILED – The document failed to be ingested.

• NOT_FOUND – The document wasn't found.

• IGNORED – The document was ignored during ingestion.

• DELETING – You submitted the delete job containing the document.

• DELETE_IN_PROGRESS – The document is being deleted.

Parameters:

status - The ingestion status of the document. The following statuses are possible:

• STARTED – You submitted the ingestion job containing the document.

• PENDING – The document is waiting to be ingested.

• IN_PROGRESS – The document is being ingested.

• INDEXED – The document was successfully indexed.

• PARTIALLY_INDEXED – The document was partially indexed.

• METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

• METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

• FAILED – The document failed to be ingested.

• NOT_FOUND – The document wasn't found.

• IGNORED – The document was ignored during ingestion.

• DELETING – You submitted the delete job containing the document.

• DELETE_IN_PROGRESS – The document is being deleted.

Returns:

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

See Also:

• DocumentStatus
• DocumentStatus

status

KnowledgeBaseDocumentDetail.Builder status(DocumentStatus status)

The ingestion status of the document. The following statuses are possible:

• STARTED – You submitted the ingestion job containing the document.

• PENDING – The document is waiting to be ingested.

• IN_PROGRESS – The document is being ingested.

• INDEXED – The document was successfully indexed.

• PARTIALLY_INDEXED – The document was partially indexed.

• METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

• METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

• FAILED – The document failed to be ingested.

• NOT_FOUND – The document wasn't found.

• IGNORED – The document was ignored during ingestion.

• DELETING – You submitted the delete job containing the document.

• DELETE_IN_PROGRESS – The document is being deleted.

Parameters:

status - The ingestion status of the document. The following statuses are possible:

• STARTED – You submitted the ingestion job containing the document.

• PENDING – The document is waiting to be ingested.

• IN_PROGRESS – The document is being ingested.

• INDEXED – The document was successfully indexed.

• PARTIALLY_INDEXED – The document was partially indexed.

• METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

• METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

• FAILED – The document failed to be ingested.

• NOT_FOUND – The document wasn't found.

• IGNORED – The document was ignored during ingestion.

• DELETING – You submitted the delete job containing the document.

• DELETE_IN_PROGRESS – The document is being deleted.

Returns:

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

See Also:

• DocumentStatus
• DocumentStatus

statusReason

KnowledgeBaseDocumentDetail.Builder statusReason(String statusReason)

The reason for the status. Appears alongside the status IGNORED.

Parameters:

statusReason - The reason for the status. Appears alongside the status IGNORED.

Returns:

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

updatedAt

KnowledgeBaseDocumentDetail.Builder updatedAt(Instant updatedAt)

The date and time at which the document was last updated.

Parameters:

updatedAt - The date and time at which the document was last updated.

Returns:

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