DescribeThesaurusResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kendra.model.DescribeThesaurusResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeThesaurusResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeThesaurusResult()

Constructors
Constructor and Description
`DescribeThesaurusResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeThesaurusResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedAt()` The Unix timestamp when the thesaurus was created.
`String`	`getDescription()` The thesaurus description.
`String`	`getErrorMessage()` When the `Status` field value is `FAILED`, the `ErrorMessage` field provides more information.
`Long`	`getFileSizeBytes()` The size of the thesaurus file in bytes.
`String`	`getId()` The identifier of the thesaurus.
`String`	`getIndexId()` The identifier of the index for the thesaurus.
`String`	`getName()` The thesaurus name.
`String`	`getRoleArn()` An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in `SourceS3Path`.
`S3Path`	`getSourceS3Path()`
`String`	`getStatus()` The current status of the thesaurus.
`Long`	`getSynonymRuleCount()` The number of synonym rules in the thesaurus file.
`Long`	`getTermCount()` The number of unique terms in the thesaurus file.
`Date`	`getUpdatedAt()` The Unix timestamp when the thesaurus was last updated.
`int`	`hashCode()`
`void`	`setCreatedAt(Date createdAt)` The Unix timestamp when the thesaurus was created.
`void`	`setDescription(String description)` The thesaurus description.
`void`	`setErrorMessage(String errorMessage)` When the `Status` field value is `FAILED`, the `ErrorMessage` field provides more information.
`void`	`setFileSizeBytes(Long fileSizeBytes)` The size of the thesaurus file in bytes.
`void`	`setId(String id)` The identifier of the thesaurus.
`void`	`setIndexId(String indexId)` The identifier of the index for the thesaurus.
`void`	`setName(String name)` The thesaurus name.
`void`	`setRoleArn(String roleArn)` An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in `SourceS3Path`.
`void`	`setSourceS3Path(S3Path sourceS3Path)`
`void`	`setStatus(String status)` The current status of the thesaurus.
`void`	`setSynonymRuleCount(Long synonymRuleCount)` The number of synonym rules in the thesaurus file.
`void`	`setTermCount(Long termCount)` The number of unique terms in the thesaurus file.
`void`	`setUpdatedAt(Date updatedAt)` The Unix timestamp when the thesaurus was last updated.
`String`	`toString()` Returns a string representation of this object.
`DescribeThesaurusResult`	`withCreatedAt(Date createdAt)` The Unix timestamp when the thesaurus was created.
`DescribeThesaurusResult`	`withDescription(String description)` The thesaurus description.
`DescribeThesaurusResult`	`withErrorMessage(String errorMessage)` When the `Status` field value is `FAILED`, the `ErrorMessage` field provides more information.
`DescribeThesaurusResult`	`withFileSizeBytes(Long fileSizeBytes)` The size of the thesaurus file in bytes.
`DescribeThesaurusResult`	`withId(String id)` The identifier of the thesaurus.
`DescribeThesaurusResult`	`withIndexId(String indexId)` The identifier of the index for the thesaurus.
`DescribeThesaurusResult`	`withName(String name)` The thesaurus name.
`DescribeThesaurusResult`	`withRoleArn(String roleArn)` An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in `SourceS3Path`.
`DescribeThesaurusResult`	`withSourceS3Path(S3Path sourceS3Path)`
`DescribeThesaurusResult`	`withStatus(String status)` The current status of the thesaurus.
`DescribeThesaurusResult`	`withStatus(ThesaurusStatus status)` The current status of the thesaurus.
`DescribeThesaurusResult`	`withSynonymRuleCount(Long synonymRuleCount)` The number of synonym rules in the thesaurus file.
`DescribeThesaurusResult`	`withTermCount(Long termCount)` The number of unique terms in the thesaurus file.
`DescribeThesaurusResult`	`withUpdatedAt(Date updatedAt)` The Unix timestamp when the thesaurus was last updated.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeThesaurusResult
```
public DescribeThesaurusResult()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the thesaurus.
    
    Parameters:
    
    id - The identifier of the thesaurus.
  - getId
```
public String getId()
```
    The identifier of the thesaurus.
    
    Returns:
    
    The identifier of the thesaurus.
  - withId
```
public DescribeThesaurusResult withId(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.
  - setIndexId
```
public void setIndexId(String indexId)
```
    The identifier of the index for the thesaurus.
    
    Parameters:
    
    indexId - The identifier of the index for the thesaurus.
  - getIndexId
```
public String getIndexId()
```
    The identifier of the index for the thesaurus.
    
    Returns:
    
    The identifier of the index for the thesaurus.
  - withIndexId
```
public DescribeThesaurusResult withIndexId(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.
  - setName
```
public void setName(String name)
```
    The thesaurus name.
    
    Parameters:
    
    name - The thesaurus name.
  - getName
```
public String getName()
```
    The thesaurus name.
    
    Returns:
    
    The thesaurus name.
  - withName
```
public DescribeThesaurusResult withName(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.
  - setDescription
```
public void setDescription(String description)
```
    The thesaurus description.
    
    Parameters:
    
    description - The thesaurus description.
  - getDescription
```
public String getDescription()
```
    The thesaurus description.
    
    Returns:
    
    The thesaurus description.
  - withDescription
```
public DescribeThesaurusResult withDescription(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.
  - setStatus
```
public void setStatus(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.
    
    See Also:
    
    ThesaurusStatus
  - getStatus
```
public String getStatus()
```
    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:
    
    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
  - withStatus
```
public DescribeThesaurusResult withStatus(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
  - withStatus
```
public DescribeThesaurusResult withStatus(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
  - setErrorMessage
```
public void setErrorMessage(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.
  - getErrorMessage
```
public String getErrorMessage()
```
    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.
  - withErrorMessage
```
public DescribeThesaurusResult withErrorMessage(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.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The Unix timestamp when the thesaurus was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the thesaurus was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The Unix timestamp when the thesaurus was created.
    
    Returns:
    
    The Unix timestamp when the thesaurus was created.
  - withCreatedAt
```
public DescribeThesaurusResult withCreatedAt(Date 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.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the thesaurus was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the thesaurus was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The Unix timestamp when the thesaurus was last updated.
    
    Returns:
    
    The Unix timestamp when the thesaurus was last updated.
  - withUpdatedAt
```
public DescribeThesaurusResult withUpdatedAt(Date 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.
  - setRoleArn
```
public void setRoleArn(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.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public DescribeThesaurusResult withRoleArn(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.
  - setSourceS3Path
```
public void setSourceS3Path(S3Path sourceS3Path)
```
    Parameters:
    
    sourceS3Path -
  - getSourceS3Path
```
public S3Path getSourceS3Path()
```
    Returns:
  - withSourceS3Path
```
public DescribeThesaurusResult withSourceS3Path(S3Path sourceS3Path)
```
    Parameters:
    
    sourceS3Path -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileSizeBytes
```
public void setFileSizeBytes(Long fileSizeBytes)
```
    The size of the thesaurus file in bytes.
    
    Parameters:
    
    fileSizeBytes - The size of the thesaurus file in bytes.
  - getFileSizeBytes
```
public Long getFileSizeBytes()
```
    The size of the thesaurus file in bytes.
    
    Returns:
    
    The size of the thesaurus file in bytes.
  - withFileSizeBytes
```
public DescribeThesaurusResult withFileSizeBytes(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.
  - setTermCount
```
public void setTermCount(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.
  - getTermCount
```
public Long getTermCount()
```
    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.
  - withTermCount
```
public DescribeThesaurusResult withTermCount(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.
  - setSynonymRuleCount
```
public void setSynonymRuleCount(Long synonymRuleCount)
```
    The number of synonym rules in the thesaurus file.
    
    Parameters:
    
    synonymRuleCount - The number of synonym rules in the thesaurus file.
  - getSynonymRuleCount
```
public Long getSynonymRuleCount()
```
    The number of synonym rules in the thesaurus file.
    
    Returns:
    
    The number of synonym rules in the thesaurus file.
  - withSynonymRuleCount
```
public DescribeThesaurusResult withSynonymRuleCount(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeThesaurusResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class DescribeThesaurusResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeThesaurusResult

Method Detail

setId

getId

withId

setIndexId

getIndexId

withIndexId

setName

getName

withName

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

withStatus

setErrorMessage

getErrorMessage

withErrorMessage

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setRoleArn

getRoleArn

withRoleArn

setSourceS3Path

getSourceS3Path

withSourceS3Path

setFileSizeBytes

getFileSizeBytes

withFileSizeBytes

setTermCount

getTermCount

withTermCount

setSynonymRuleCount

getSynonymRuleCount

withSynonymRuleCount

toString

equals

hashCode

clone