Package software.amazon.awssdk.services.kendra.model

Class DescribeThesaurusResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendra.model.KendraResponse

software.amazon.awssdk.services.kendra.model.DescribeThesaurusResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeThesaurusResponse.Builder,DescribeThesaurusResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeThesaurusResponse
extends KendraResponse
implements ToCopyableBuilder<DescribeThesaurusResponse.Builder,DescribeThesaurusResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeThesaurusResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeThesaurusResponse.Builder	builder()
Instant	createdAt()	The Unix timestamp when the thesaurus was created.
String	description()	The thesaurus description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorMessage()	When the Status field value is FAILED, the ErrorMessage field provides more information.
Long	fileSizeBytes()	The size of the thesaurus file in bytes.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the thesaurus.
String	indexId()	The identifier of the index for the thesaurus.
String	name()	The thesaurus name.
String	roleArn()	An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeThesaurusResponse.Builder>	serializableBuilderClass()
S3Path	sourceS3Path()	Returns the value of the SourceS3Path property for this object.
ThesaurusStatus	status()	The current status of the thesaurus.
String	statusAsString()	The current status of the thesaurus.
Long	synonymRuleCount()	The number of synonym rules in the thesaurus file.
Long	termCount()	The number of unique terms in the thesaurus file.
DescribeThesaurusResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The Unix timestamp when the thesaurus was last updated.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The identifier of the thesaurus.

Returns:

The identifier of the thesaurus.

indexId

public final String indexId()

The identifier of the index for the thesaurus.

Returns:

The identifier of the index for the thesaurus.

name

public final String name()

The thesaurus name.

Returns:

The thesaurus name.

description

public final String description()

The thesaurus description.

Returns:

The thesaurus description.

status

public final 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.

If the service returns an enum value that is not available in the current SDK version, status will return ThesaurusStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

ThesaurusStatus

statusAsString

public final String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return ThesaurusStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

ThesaurusStatus

errorMessage

public final String errorMessage()

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

Returns:

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

createdAt

public final Instant createdAt()

The Unix timestamp when the thesaurus was created.

Returns:

The Unix timestamp when the thesaurus was created.

updatedAt

public final Instant updatedAt()

The Unix timestamp when the thesaurus was last updated.

Returns:

The Unix timestamp when the thesaurus was last updated.

roleArn

public final String roleArn()

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

Returns:

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

sourceS3Path

public final S3Path sourceS3Path()

Returns the value of the SourceS3Path property for this object.

Returns:

The value of the SourceS3Path property for this object.

fileSizeBytes

public final Long fileSizeBytes()

The size of the thesaurus file in bytes.

Returns:

The size of the thesaurus file in bytes.

termCount

public final 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.

Returns:

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.

synonymRuleCount

public final Long synonymRuleCount()

The number of synonym rules in the thesaurus file.

Returns:

The number of synonym rules in the thesaurus file.

toBuilder

public DescribeThesaurusResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeThesaurusResponse.Builder,DescribeThesaurusResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeThesaurusResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeThesaurusResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo