software.amazon.awssdk.services.kendra.model

Interface DescribeThesaurusResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeThesaurusResponse.Builder,DescribeThesaurusResponse>, KendraResponse.Builder, SdkBuilder<DescribeThesaurusResponse.Builder,DescribeThesaurusResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeThesaurusResponse

public static interface DescribeThesaurusResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<DescribeThesaurusResponse.Builder,DescribeThesaurusResponse>

Method Summary

Modifier and Type	Method and Description
DescribeThesaurusResponse.Builder	createdAt(Instant createdAt) The Unix timestamp when the thesaurus was created.
DescribeThesaurusResponse.Builder	description(String description) The thesaurus description.
DescribeThesaurusResponse.Builder	errorMessage(String errorMessage) When the Status field value is FAILED, the ErrorMessage field provides more information.
DescribeThesaurusResponse.Builder	fileSizeBytes(Long fileSizeBytes) The size of the thesaurus file in bytes.
DescribeThesaurusResponse.Builder	id(String id) The identifier of the thesaurus.
DescribeThesaurusResponse.Builder	indexId(String indexId) The identifier of the index for the thesaurus.
DescribeThesaurusResponse.Builder	name(String name) The thesaurus name.
DescribeThesaurusResponse.Builder	roleArn(String roleArn) An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
default DescribeThesaurusResponse.Builder	sourceS3Path(Consumer<S3Path.Builder> sourceS3Path) Sets the value of the SourceS3Path property for this object.
DescribeThesaurusResponse.Builder	sourceS3Path(S3Path sourceS3Path) Sets the value of the SourceS3Path property for this object.
DescribeThesaurusResponse.Builder	status(String status) The current status of the thesaurus.
DescribeThesaurusResponse.Builder	status(ThesaurusStatus status) The current status of the thesaurus.
DescribeThesaurusResponse.Builder	synonymRuleCount(Long synonymRuleCount) The number of synonym rules in the thesaurus file.
DescribeThesaurusResponse.Builder	termCount(Long termCount) The number of unique terms in the thesaurus file.
DescribeThesaurusResponse.Builder	updatedAt(Instant updatedAt) The Unix timestamp when the thesaurus was last updated.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

id

DescribeThesaurusResponse.Builder id(String id)

The identifier of the thesaurus.

Parameters:

id - The identifier of the thesaurus.

Returns:

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

indexId

DescribeThesaurusResponse.Builder indexId(String indexId)

The identifier of the index for the thesaurus.

Parameters:

indexId - The identifier of the index for the thesaurus.

Returns:

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

name

DescribeThesaurusResponse.Builder name(String name)

The thesaurus name.

Parameters:

name - The thesaurus name.

Returns:

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

description

DescribeThesaurusResponse.Builder description(String description)

The thesaurus description.

Parameters:

description - The thesaurus description.

Returns:

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

status

DescribeThesaurusResponse.Builder status(String status)

The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

Parameters:

status - The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

Returns:

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

See Also:

ThesaurusStatus, ThesaurusStatus

status

DescribeThesaurusResponse.Builder status(ThesaurusStatus status)

The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

Parameters:

status - The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

Returns:

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

See Also:

ThesaurusStatus, ThesaurusStatus

errorMessage

DescribeThesaurusResponse.Builder errorMessage(String errorMessage)

When the Status field value is FAILED, the ErrorMessage field provides more information.

Parameters:

errorMessage - When the Status field value is FAILED, the ErrorMessage field provides more information.

Returns:

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

createdAt

DescribeThesaurusResponse.Builder createdAt(Instant createdAt)

The Unix timestamp when the thesaurus was created.

Parameters:

createdAt - The Unix timestamp when the thesaurus was created.

Returns:

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

updatedAt

DescribeThesaurusResponse.Builder updatedAt(Instant updatedAt)

The Unix timestamp when the thesaurus was last updated.

Parameters:

updatedAt - The Unix timestamp when the thesaurus was last updated.

Returns:

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

roleArn

DescribeThesaurusResponse.Builder roleArn(String roleArn)

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

Parameters:

roleArn - An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

Returns:

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

sourceS3Path

DescribeThesaurusResponse.Builder sourceS3Path(S3Path sourceS3Path)

Sets the value of the SourceS3Path property for this object.

Parameters:

sourceS3Path - The new value for the SourceS3Path property for this object.

Returns:

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

sourceS3Path

default DescribeThesaurusResponse.Builder sourceS3Path(Consumer<S3Path.Builder> sourceS3Path)

Sets the value of the SourceS3Path property for this object. This is a convenience method that creates an instance of the S3Path.Builder avoiding the need to create one manually via S3Path.builder().

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

Parameters:

sourceS3Path - a consumer that will call methods on S3Path.Builder

Returns:

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

See Also:

sourceS3Path(S3Path)

fileSizeBytes

DescribeThesaurusResponse.Builder fileSizeBytes(Long fileSizeBytes)

The size of the thesaurus file in bytes.

Parameters:

fileSizeBytes - The size of the thesaurus file in bytes.

Returns:

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

termCount

DescribeThesaurusResponse.Builder termCount(Long termCount)

The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.

Parameters:

termCount - The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.

Returns:

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

synonymRuleCount

DescribeThesaurusResponse.Builder synonymRuleCount(Long synonymRuleCount)

The number of synonym rules in the thesaurus file.

Parameters:

synonymRuleCount - The number of synonym rules in the thesaurus file.

Returns:

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