/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeThesaurusResult extends com.amazonaws.AmazonWebServiceResult
* The identifier of the thesaurus.
*
* The identifier of the index for the thesaurus.
*
* The thesaurus name.
*
* The thesaurus description.
*
* The current status of the thesaurus. When the value is
* If the status is
* When the
* The Unix timestamp when the thesaurus was created.
*
* The Unix timestamp when the thesaurus was last updated.
*
* An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in
* The size of the thesaurus file in bytes.
*
* The number of unique terms in the thesaurus file. For example, the synonyms
* The number of synonym rules in the thesaurus file.
*
* The identifier of the thesaurus.
*
* The identifier of the thesaurus.
*
* The identifier of the thesaurus.
*
* The identifier of the index for the thesaurus.
*
* The identifier of the index for the thesaurus.
*
* The identifier of the index for the thesaurus.
*
* The thesaurus name.
*
* The thesaurus name.
*
* The thesaurus name.
*
* The thesaurus description.
*
* The thesaurus description.
*
* The thesaurus description.
*
* The current status of the thesaurus. When the value is
* If the status is ACTIVE
, queries are able to use the
* thesaurus. If the Status
field value is FAILED
, the ErrorMessage
field
* provides more information.
* ACTIVE_BUT_UPDATE_FAILED
, it means that Amazon Kendra could not ingest the new
* thesaurus file. The old thesaurus file is still active.
* Status
field value is FAILED
, the ErrorMessage
field provides
* more information.
* SourceS3Path
.
* a,b,c
and
* a=>d
, the term count would be 4.
* ACTIVE
, queries are able to use the
* thesaurus. If the Status
field value is FAILED
, the ErrorMessage
field
* provides more information.
* ACTIVE_BUT_UPDATE_FAILED
, it means that Amazon Kendra could not ingest the new
* thesaurus file. The old thesaurus file is still active.
* 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 ThesaurusStatus
*/
public void setStatus(String status) {
this.status = 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.
*
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 ThesaurusStatus
*/
public String getStatus() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ThesaurusStatus
*/
public DescribeThesaurusResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ThesaurusStatus
*/
public DescribeThesaurusResult withStatus(ThesaurusStatus status) {
this.status = status.toString();
return this;
}
/**
*
* When the Status
field value is FAILED
, the ErrorMessage
field provides
* more information.
*
Status
field value is FAILED
, the ErrorMessage
field
* provides more information.
*/
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
/**
*
* When the Status
field value is FAILED
, the ErrorMessage
field provides
* more information.
*
Status
field value is FAILED
, the ErrorMessage
field
* provides more information.
*/
public String getErrorMessage() {
return this.errorMessage;
}
/**
*
* When the Status
field value is FAILED
, the ErrorMessage
field provides
* more information.
*
Status
field value is FAILED
, the ErrorMessage
field
* provides more information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThesaurusResult withErrorMessage(String errorMessage) {
setErrorMessage(errorMessage);
return this;
}
/**
* * The Unix timestamp when the thesaurus was created. *
* * @param createdAt * The Unix timestamp when the thesaurus was created. */ public void setCreatedAt(java.util.Date createdAt) { this.createdAt = createdAt; } /** ** The Unix timestamp when the thesaurus was created. *
* * @return The Unix timestamp when the thesaurus was created. */ public java.util.Date getCreatedAt() { return this.createdAt; } /** ** The Unix timestamp when the thesaurus was created. *
* * @param createdAt * The Unix timestamp when the thesaurus was created. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeThesaurusResult withCreatedAt(java.util.Date createdAt) { setCreatedAt(createdAt); return this; } /** ** The Unix timestamp when the thesaurus was last updated. *
* * @param updatedAt * The Unix timestamp when the thesaurus was last updated. */ public void setUpdatedAt(java.util.Date updatedAt) { this.updatedAt = updatedAt; } /** ** The Unix timestamp when the thesaurus was last updated. *
* * @return The Unix timestamp when the thesaurus was last updated. */ public java.util.Date getUpdatedAt() { return this.updatedAt; } /** ** The Unix timestamp when the thesaurus was last updated. *
* * @param updatedAt * The Unix timestamp when the thesaurus was last updated. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeThesaurusResult withUpdatedAt(java.util.Date updatedAt) { setUpdatedAt(updatedAt); return this; } /** *
* An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path
.
*
SourceS3Path
.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path
.
*
SourceS3Path
.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path
.
*
SourceS3Path
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThesaurusResult withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
* @param sourceS3Path
*/
public void setSourceS3Path(S3Path sourceS3Path) {
this.sourceS3Path = sourceS3Path;
}
/**
* @return
*/
public S3Path getSourceS3Path() {
return this.sourceS3Path;
}
/**
* @param sourceS3Path
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThesaurusResult withSourceS3Path(S3Path sourceS3Path) {
setSourceS3Path(sourceS3Path);
return this;
}
/**
* * The size of the thesaurus file in bytes. *
* * @param fileSizeBytes * The size of the thesaurus file in bytes. */ public void setFileSizeBytes(Long fileSizeBytes) { this.fileSizeBytes = fileSizeBytes; } /** ** The size of the thesaurus file in bytes. *
* * @return The size of the thesaurus file in bytes. */ public Long getFileSizeBytes() { return this.fileSizeBytes; } /** ** The size of the thesaurus file in bytes. *
* * @param fileSizeBytes * The size of the thesaurus file in bytes. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeThesaurusResult withFileSizeBytes(Long fileSizeBytes) { setFileSizeBytes(fileSizeBytes); return this; } /** *
* 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.
*
a,b,c
and
* a=>d
, the term count would be 4.
*/
public void setTermCount(Long termCount) {
this.termCount = 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.
*
a,b,c
and
* a=>d
, the term count would be 4.
*/
public Long getTermCount() {
return this.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.
*
a,b,c
and
* a=>d
, the term count would be 4.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThesaurusResult withTermCount(Long termCount) {
setTermCount(termCount);
return this;
}
/**
* * The number of synonym rules in the thesaurus file. *
* * @param synonymRuleCount * The number of synonym rules in the thesaurus file. */ public void setSynonymRuleCount(Long synonymRuleCount) { this.synonymRuleCount = synonymRuleCount; } /** ** The number of synonym rules in the thesaurus file. *
* * @return The number of synonym rules in the thesaurus file. */ public Long getSynonymRuleCount() { return this.synonymRuleCount; } /** ** The number of synonym rules in the thesaurus file. *
* * @param synonymRuleCount * The number of synonym rules in the thesaurus file. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeThesaurusResult withSynonymRuleCount(Long synonymRuleCount) { setSynonymRuleCount(synonymRuleCount); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getId() != null) sb.append("Id: ").append(getId()).append(","); if (getIndexId() != null) sb.append("IndexId: ").append(getIndexId()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getErrorMessage() != null) sb.append("ErrorMessage: ").append(getErrorMessage()).append(","); if (getCreatedAt() != null) sb.append("CreatedAt: ").append(getCreatedAt()).append(","); if (getUpdatedAt() != null) sb.append("UpdatedAt: ").append(getUpdatedAt()).append(","); if (getRoleArn() != null) sb.append("RoleArn: ").append(getRoleArn()).append(","); if (getSourceS3Path() != null) sb.append("SourceS3Path: ").append(getSourceS3Path()).append(","); if (getFileSizeBytes() != null) sb.append("FileSizeBytes: ").append(getFileSizeBytes()).append(","); if (getTermCount() != null) sb.append("TermCount: ").append(getTermCount()).append(","); if (getSynonymRuleCount() != null) sb.append("SynonymRuleCount: ").append(getSynonymRuleCount()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeThesaurusResult == false) return false; DescribeThesaurusResult other = (DescribeThesaurusResult) obj; if (other.getId() == null ^ this.getId() == null) return false; if (other.getId() != null && other.getId().equals(this.getId()) == false) return false; if (other.getIndexId() == null ^ this.getIndexId() == null) return false; if (other.getIndexId() != null && other.getIndexId().equals(this.getIndexId()) == false) return false; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getErrorMessage() == null ^ this.getErrorMessage() == null) return false; if (other.getErrorMessage() != null && other.getErrorMessage().equals(this.getErrorMessage()) == false) return false; if (other.getCreatedAt() == null ^ this.getCreatedAt() == null) return false; if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false) return false; if (other.getUpdatedAt() == null ^ this.getUpdatedAt() == null) return false; if (other.getUpdatedAt() != null && other.getUpdatedAt().equals(this.getUpdatedAt()) == false) return false; if (other.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getSourceS3Path() == null ^ this.getSourceS3Path() == null) return false; if (other.getSourceS3Path() != null && other.getSourceS3Path().equals(this.getSourceS3Path()) == false) return false; if (other.getFileSizeBytes() == null ^ this.getFileSizeBytes() == null) return false; if (other.getFileSizeBytes() != null && other.getFileSizeBytes().equals(this.getFileSizeBytes()) == false) return false; if (other.getTermCount() == null ^ this.getTermCount() == null) return false; if (other.getTermCount() != null && other.getTermCount().equals(this.getTermCount()) == false) return false; if (other.getSynonymRuleCount() == null ^ this.getSynonymRuleCount() == null) return false; if (other.getSynonymRuleCount() != null && other.getSynonymRuleCount().equals(this.getSynonymRuleCount()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode()); hashCode = prime * hashCode + ((getIndexId() == null) ? 0 : getIndexId().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getErrorMessage() == null) ? 0 : getErrorMessage().hashCode()); hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode()); hashCode = prime * hashCode + ((getUpdatedAt() == null) ? 0 : getUpdatedAt().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getSourceS3Path() == null) ? 0 : getSourceS3Path().hashCode()); hashCode = prime * hashCode + ((getFileSizeBytes() == null) ? 0 : getFileSizeBytes().hashCode()); hashCode = prime * hashCode + ((getTermCount() == null) ? 0 : getTermCount().hashCode()); hashCode = prime * hashCode + ((getSynonymRuleCount() == null) ? 0 : getSynonymRuleCount().hashCode()); return hashCode; } @Override public DescribeThesaurusResult clone() { try { return (DescribeThesaurusResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }