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>

  • Method Details

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeThesaurusResponse.Builder,DescribeThesaurusResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.