/** * 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 DescribeQuerySuggestionsBlockListResult { public: AWS_KENDRA_API DescribeQuerySuggestionsBlockListResult(); AWS_KENDRA_API DescribeQuerySuggestionsBlockListResult(const Aws::AmazonWebServiceResult& result); AWS_KENDRA_API DescribeQuerySuggestionsBlockListResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The identifier of the index for the block list.

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

The identifier of the index for the block list.

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

The identifier of the index for the block list.

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

The identifier of the index for the block list.

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

The identifier of the index for the block list.

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

The identifier of the index for the block list.

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

The identifier of the index for the block list.

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

The identifier of the block list.

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

The identifier of the block list.

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

The identifier of the block list.

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

The identifier of the block list.

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

The identifier of the block list.

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

The identifier of the block list.

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

The identifier of the block list.

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

The name of the block list.

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

The name of the block list.

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

The name of the block list.

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

The name of the block list.

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

The name of the block list.

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

The name of the block list.

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

The name of the block list.

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

The description for the block list.

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

The description for the block list.

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

The description for the block list.

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

The description for the block list.

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

The description for the block list.

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

The description for the block list.

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

The description for the block list.

*/ inline DescribeQuerySuggestionsBlockListResult& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The current status of the block list. When the value is ACTIVE, * the block list is ready for use.

*/ inline const QuerySuggestionsBlockListStatus& GetStatus() const{ return m_status; } /** *

The current status of the block list. When the value is ACTIVE, * the block list is ready for use.

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

The current status of the block list. When the value is ACTIVE, * the block list is ready for use.

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

The current status of the block list. When the value is ACTIVE, * the block list is ready for use.

*/ inline DescribeQuerySuggestionsBlockListResult& WithStatus(const QuerySuggestionsBlockListStatus& value) { SetStatus(value); return *this;} /** *

The current status of the block list. When the value is ACTIVE, * the block list is ready for use.

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

The error message containing details if there are issues processing the block * list.

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

The error message containing details if there are issues processing the block * list.

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

The error message containing details if there are issues processing the block * list.

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

The error message containing details if there are issues processing the block * list.

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

The error message containing details if there are issues processing the block * list.

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

The error message containing details if there are issues processing the block * list.

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

The error message containing details if there are issues processing the block * list.

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

The Unix timestamp when a block list for query suggestions was created.

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

The Unix timestamp when a block list for query suggestions was created.

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

The Unix timestamp when a block list for query suggestions was created.

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

The Unix timestamp when a block list for query suggestions was created.

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

The Unix timestamp when a block list for query suggestions was created.

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

The Unix timestamp when a block list for query suggestions was last * updated.

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

The Unix timestamp when a block list for query suggestions was last * updated.

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

The Unix timestamp when a block list for query suggestions was last * updated.

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

The Unix timestamp when a block list for query suggestions was last * updated.

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

The Unix timestamp when a block list for query suggestions was last * updated.

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

Shows the current S3 path to your block list text file in your S3 bucket.

*

Each block word or phrase should be on a separate line in a text file.

*

For information on the current quota limits for block lists, see Quotas for * Amazon Kendra.

*/ inline const S3Path& GetSourceS3Path() const{ return m_sourceS3Path; } /** *

Shows the current S3 path to your block list text file in your S3 bucket.

*

Each block word or phrase should be on a separate line in a text file.

*

For information on the current quota limits for block lists, see Quotas for * Amazon Kendra.

*/ inline void SetSourceS3Path(const S3Path& value) { m_sourceS3Path = value; } /** *

Shows the current S3 path to your block list text file in your S3 bucket.

*

Each block word or phrase should be on a separate line in a text file.

*

For information on the current quota limits for block lists, see Quotas for * Amazon Kendra.

*/ inline void SetSourceS3Path(S3Path&& value) { m_sourceS3Path = std::move(value); } /** *

Shows the current S3 path to your block list text file in your S3 bucket.

*

Each block word or phrase should be on a separate line in a text file.

*

For information on the current quota limits for block lists, see Quotas for * Amazon Kendra.

*/ inline DescribeQuerySuggestionsBlockListResult& WithSourceS3Path(const S3Path& value) { SetSourceS3Path(value); return *this;} /** *

Shows the current S3 path to your block list text file in your S3 bucket.

*

Each block word or phrase should be on a separate line in a text file.

*

For information on the current quota limits for block lists, see Quotas for * Amazon Kendra.

*/ inline DescribeQuerySuggestionsBlockListResult& WithSourceS3Path(S3Path&& value) { SetSourceS3Path(std::move(value)); return *this;} /** *

The current number of valid, non-empty words or phrases in the block list * text file.

*/ inline int GetItemCount() const{ return m_itemCount; } /** *

The current number of valid, non-empty words or phrases in the block list * text file.

*/ inline void SetItemCount(int value) { m_itemCount = value; } /** *

The current number of valid, non-empty words or phrases in the block list * text file.

*/ inline DescribeQuerySuggestionsBlockListResult& WithItemCount(int value) { SetItemCount(value); return *this;} /** *

The current size of the block list text file in S3.

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

The current size of the block list text file in S3.

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

The current size of the block list text file in S3.

*/ inline DescribeQuerySuggestionsBlockListResult& WithFileSizeBytes(long long value) { SetFileSizeBytes(value); return *this;} /** *

The IAM (Identity and Access Management) role used by Amazon Kendra to access * the block list text file in S3.

The role needs S3 read permissions to * your file in S3 and needs to give STS (Security Token Service) assume role * permissions to Amazon Kendra.

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

The IAM (Identity and Access Management) role used by Amazon Kendra to access * the block list text file in S3.

The role needs S3 read permissions to * your file in S3 and needs to give STS (Security Token Service) assume role * permissions to Amazon Kendra.

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

The IAM (Identity and Access Management) role used by Amazon Kendra to access * the block list text file in S3.

The role needs S3 read permissions to * your file in S3 and needs to give STS (Security Token Service) assume role * permissions to Amazon Kendra.

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

The IAM (Identity and Access Management) role used by Amazon Kendra to access * the block list text file in S3.

The role needs S3 read permissions to * your file in S3 and needs to give STS (Security Token Service) assume role * permissions to Amazon Kendra.

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

The IAM (Identity and Access Management) role used by Amazon Kendra to access * the block list text file in S3.

The role needs S3 read permissions to * your file in S3 and needs to give STS (Security Token Service) assume role * permissions to Amazon Kendra.

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

The IAM (Identity and Access Management) role used by Amazon Kendra to access * the block list text file in S3.

The role needs S3 read permissions to * your file in S3 and needs to give STS (Security Token Service) assume role * permissions to Amazon Kendra.

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

The IAM (Identity and Access Management) role used by Amazon Kendra to access * the block list text file in S3.

The role needs S3 read permissions to * your file in S3 and needs to give STS (Security Token Service) assume role * permissions to Amazon Kendra.

*/ inline DescribeQuerySuggestionsBlockListResult& WithRoleArn(const char* value) { SetRoleArn(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 DescribeQuerySuggestionsBlockListResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeQuerySuggestionsBlockListResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeQuerySuggestionsBlockListResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_indexId; Aws::String m_id; Aws::String m_name; Aws::String m_description; QuerySuggestionsBlockListStatus m_status; Aws::String m_errorMessage; Aws::Utils::DateTime m_createdAt; Aws::Utils::DateTime m_updatedAt; S3Path m_sourceS3Path; int m_itemCount; long long m_fileSizeBytes; Aws::String m_roleArn; Aws::String m_requestId; }; } // namespace Model } // namespace kendra } // namespace Aws