/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace kendra { namespace Model { class DescribeThesaurusResult { public: AWS_KENDRA_API DescribeThesaurusResult(); AWS_KENDRA_API DescribeThesaurusResult(const Aws::AmazonWebServiceResult& result); AWS_KENDRA_API DescribeThesaurusResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The identifier of the thesaurus.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

The identifier of the thesaurus.

*/ inline void SetId(const Aws::String& value) { m_id = value; } /** *

The identifier of the thesaurus.

*/ inline void SetId(Aws::String&& value) { m_id = std::move(value); } /** *

The identifier of the thesaurus.

*/ inline void SetId(const char* value) { m_id.assign(value); } /** *

The identifier of the thesaurus.

*/ inline DescribeThesaurusResult& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

The identifier of the thesaurus.

*/ inline DescribeThesaurusResult& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

The identifier of the thesaurus.

*/ inline DescribeThesaurusResult& WithId(const char* value) { SetId(value); return *this;} /** *

The identifier of the index for the thesaurus.

*/ inline const Aws::String& GetIndexId() const{ return m_indexId; } /** *

The identifier of the index for the thesaurus.

*/ inline void SetIndexId(const Aws::String& value) { m_indexId = value; } /** *

The identifier of the index for the thesaurus.

*/ inline void SetIndexId(Aws::String&& value) { m_indexId = std::move(value); } /** *

The identifier of the index for the thesaurus.

*/ inline void SetIndexId(const char* value) { m_indexId.assign(value); } /** *

The identifier of the index for the thesaurus.

*/ inline DescribeThesaurusResult& WithIndexId(const Aws::String& value) { SetIndexId(value); return *this;} /** *

The identifier of the index for the thesaurus.

*/ inline DescribeThesaurusResult& WithIndexId(Aws::String&& value) { SetIndexId(std::move(value)); return *this;} /** *

The identifier of the index for the thesaurus.

*/ inline DescribeThesaurusResult& WithIndexId(const char* value) { SetIndexId(value); return *this;} /** *

The thesaurus name.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The thesaurus name.

*/ inline void SetName(const Aws::String& value) { m_name = value; } /** *

The thesaurus name.

*/ inline void SetName(Aws::String&& value) { m_name = std::move(value); } /** *

The thesaurus name.

*/ inline void SetName(const char* value) { m_name.assign(value); } /** *

The thesaurus name.

*/ inline DescribeThesaurusResult& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The thesaurus name.

*/ inline DescribeThesaurusResult& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The thesaurus name.

*/ inline DescribeThesaurusResult& WithName(const char* value) { SetName(value); return *this;} /** *

The thesaurus description.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The thesaurus description.

*/ inline void SetDescription(const Aws::String& value) { m_description = value; } /** *

The thesaurus description.

*/ inline void SetDescription(Aws::String&& value) { m_description = std::move(value); } /** *

The thesaurus description.

*/ inline void SetDescription(const char* value) { m_description.assign(value); } /** *

The thesaurus description.

*/ inline DescribeThesaurusResult& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The thesaurus description.

*/ inline DescribeThesaurusResult& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The thesaurus description.

*/ inline DescribeThesaurusResult& WithDescription(const char* value) { SetDescription(value); 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.

*/ inline const ThesaurusStatus& GetStatus() const{ return m_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.

*/ inline void SetStatus(const ThesaurusStatus& value) { m_status = value; } /** *

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.

*/ inline void SetStatus(ThesaurusStatus&& value) { m_status = std::move(value); } /** *

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.

*/ inline DescribeThesaurusResult& WithStatus(const ThesaurusStatus& value) { SetStatus(value); 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.

*/ inline DescribeThesaurusResult& WithStatus(ThesaurusStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetErrorMessage() const{ return m_errorMessage; } /** *

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

*/ inline void SetErrorMessage(const Aws::String& value) { m_errorMessage = value; } /** *

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

*/ inline void SetErrorMessage(Aws::String&& value) { m_errorMessage = std::move(value); } /** *

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

*/ inline void SetErrorMessage(const char* value) { m_errorMessage.assign(value); } /** *

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

*/ inline DescribeThesaurusResult& WithErrorMessage(const Aws::String& value) { SetErrorMessage(value); return *this;} /** *

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

*/ inline DescribeThesaurusResult& WithErrorMessage(Aws::String&& value) { SetErrorMessage(std::move(value)); return *this;} /** *

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

*/ inline DescribeThesaurusResult& WithErrorMessage(const char* value) { SetErrorMessage(value); return *this;} /** *

The Unix timestamp when the thesaurus was created.

*/ inline const Aws::Utils::DateTime& GetCreatedAt() const{ return m_createdAt; } /** *

The Unix timestamp when the thesaurus was created.

*/ inline void SetCreatedAt(const Aws::Utils::DateTime& value) { m_createdAt = value; } /** *

The Unix timestamp when the thesaurus was created.

*/ inline void SetCreatedAt(Aws::Utils::DateTime&& value) { m_createdAt = std::move(value); } /** *

The Unix timestamp when the thesaurus was created.

*/ inline DescribeThesaurusResult& WithCreatedAt(const Aws::Utils::DateTime& value) { SetCreatedAt(value); return *this;} /** *

The Unix timestamp when the thesaurus was created.

*/ inline DescribeThesaurusResult& WithCreatedAt(Aws::Utils::DateTime&& value) { SetCreatedAt(std::move(value)); return *this;} /** *

The Unix timestamp when the thesaurus was last updated.

*/ inline const Aws::Utils::DateTime& GetUpdatedAt() const{ return m_updatedAt; } /** *

The Unix timestamp when the thesaurus was last updated.

*/ inline void SetUpdatedAt(const Aws::Utils::DateTime& value) { m_updatedAt = value; } /** *

The Unix timestamp when the thesaurus was last updated.

*/ inline void SetUpdatedAt(Aws::Utils::DateTime&& value) { m_updatedAt = std::move(value); } /** *

The Unix timestamp when the thesaurus was last updated.

*/ inline DescribeThesaurusResult& WithUpdatedAt(const Aws::Utils::DateTime& value) { SetUpdatedAt(value); return *this;} /** *

The Unix timestamp when the thesaurus was last updated.

*/ inline DescribeThesaurusResult& WithUpdatedAt(Aws::Utils::DateTime&& value) { SetUpdatedAt(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

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

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArn = value; } /** *

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

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArn = std::move(value); } /** *

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

*/ inline void SetRoleArn(const char* value) { m_roleArn.assign(value); } /** *

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

*/ inline DescribeThesaurusResult& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

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

*/ inline DescribeThesaurusResult& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

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

*/ inline DescribeThesaurusResult& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} inline const S3Path& GetSourceS3Path() const{ return m_sourceS3Path; } inline void SetSourceS3Path(const S3Path& value) { m_sourceS3Path = value; } inline void SetSourceS3Path(S3Path&& value) { m_sourceS3Path = std::move(value); } inline DescribeThesaurusResult& WithSourceS3Path(const S3Path& value) { SetSourceS3Path(value); return *this;} inline DescribeThesaurusResult& WithSourceS3Path(S3Path&& value) { SetSourceS3Path(std::move(value)); return *this;} /** *

The size of the thesaurus file in bytes.

*/ inline long long GetFileSizeBytes() const{ return m_fileSizeBytes; } /** *

The size of the thesaurus file in bytes.

*/ inline void SetFileSizeBytes(long long value) { m_fileSizeBytes = value; } /** *

The size of the thesaurus file in bytes.

*/ inline DescribeThesaurusResult& WithFileSizeBytes(long long value) { SetFileSizeBytes(value); 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.

*/ inline long long GetTermCount() const{ return m_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.

*/ inline void SetTermCount(long long value) { m_termCount = value; } /** *

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.

*/ inline DescribeThesaurusResult& WithTermCount(long long value) { SetTermCount(value); return *this;} /** *

The number of synonym rules in the thesaurus file.

*/ inline long long GetSynonymRuleCount() const{ return m_synonymRuleCount; } /** *

The number of synonym rules in the thesaurus file.

*/ inline void SetSynonymRuleCount(long long value) { m_synonymRuleCount = value; } /** *

The number of synonym rules in the thesaurus file.

*/ inline DescribeThesaurusResult& WithSynonymRuleCount(long long value) { SetSynonymRuleCount(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeThesaurusResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeThesaurusResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeThesaurusResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_id; Aws::String m_indexId; Aws::String m_name; Aws::String m_description; ThesaurusStatus m_status; Aws::String m_errorMessage; Aws::Utils::DateTime m_createdAt; Aws::Utils::DateTime m_updatedAt; Aws::String m_roleArn; S3Path m_sourceS3Path; long long m_fileSizeBytes; long long m_termCount; long long m_synonymRuleCount; Aws::String m_requestId; }; } // namespace Model } // namespace kendra } // namespace Aws