Interface DescribeThesaurusResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeThesaurusResponse.Builder,
,DescribeThesaurusResponse> KendraResponse.Builder
,SdkBuilder<DescribeThesaurusResponse.Builder,
,DescribeThesaurusResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeThesaurusResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe Unix timestamp when the thesaurus was created.description
(String description) The thesaurus description.errorMessage
(String errorMessage) When theStatus
field value isFAILED
, theErrorMessage
field provides more information.fileSizeBytes
(Long fileSizeBytes) The size of the thesaurus file in bytes.The identifier of the thesaurus.The identifier of the index for the thesaurus.The thesaurus name.An IAM role that gives Amazon Kendra permissions to access thesaurus file specified inSourceS3Path
.sourceS3Path
(Consumer<S3Path.Builder> sourceS3Path) Sets the value of the SourceS3Path property for this object.sourceS3Path
(S3Path sourceS3Path) Sets the value of the SourceS3Path property for this object.The current status of the thesaurus.status
(ThesaurusStatus status) The current status of the thesaurus.synonymRuleCount
(Long synonymRuleCount) The number of synonym rules in the thesaurus file.The number of unique terms in the thesaurus file.The Unix timestamp when the thesaurus was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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
The thesaurus name.
- Parameters:
name
- The thesaurus name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The current status of the thesaurus. When the value is
ACTIVE
, queries are able to use the thesaurus. If theStatus
field value isFAILED
, theErrorMessage
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 isACTIVE
, queries are able to use the thesaurus. If theStatus
field value isFAILED
, theErrorMessage
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:
-
status
The current status of the thesaurus. When the value is
ACTIVE
, queries are able to use the thesaurus. If theStatus
field value isFAILED
, theErrorMessage
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 isACTIVE
, queries are able to use the thesaurus. If theStatus
field value isFAILED
, theErrorMessage
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:
-
errorMessage
When the
Status
field value isFAILED
, theErrorMessage
field provides more information.- Parameters:
errorMessage
- When theStatus
field value isFAILED
, theErrorMessage
field provides more information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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 inSourceS3Path
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
Sets the value of the SourceS3Path property for this object. This is a convenience method that creates an instance of theS3Path.Builder
avoiding the need to create one manually viaS3Path.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceS3Path(S3Path)
.- Parameters:
sourceS3Path
- a consumer that will call methods onS3Path.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The number of unique terms in the thesaurus file. For example, the synonyms
a,b,c
anda=>d
, the term count would be 4.- Parameters:
termCount
- The number of unique terms in the thesaurus file. For example, the synonymsa,b,c
anda=>d
, the term count would be 4.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-