/** * 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 { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace kendra { namespace Model { /** *

A set of featured results that are displayed at the top of your search * results. Featured results are placed above all other results for certain * queries. If there's an exact match of a query, then one or more specific * documents are featured in the search results.

See Also:

AWS * API Reference

*/ class FeaturedResultsSet { public: AWS_KENDRA_API FeaturedResultsSet(); AWS_KENDRA_API FeaturedResultsSet(Aws::Utils::Json::JsonView jsonValue); AWS_KENDRA_API FeaturedResultsSet& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_KENDRA_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The identifier of the set of featured results.

*/ inline const Aws::String& GetFeaturedResultsSetId() const{ return m_featuredResultsSetId; } /** *

The identifier of the set of featured results.

*/ inline bool FeaturedResultsSetIdHasBeenSet() const { return m_featuredResultsSetIdHasBeenSet; } /** *

The identifier of the set of featured results.

*/ inline void SetFeaturedResultsSetId(const Aws::String& value) { m_featuredResultsSetIdHasBeenSet = true; m_featuredResultsSetId = value; } /** *

The identifier of the set of featured results.

*/ inline void SetFeaturedResultsSetId(Aws::String&& value) { m_featuredResultsSetIdHasBeenSet = true; m_featuredResultsSetId = std::move(value); } /** *

The identifier of the set of featured results.

*/ inline void SetFeaturedResultsSetId(const char* value) { m_featuredResultsSetIdHasBeenSet = true; m_featuredResultsSetId.assign(value); } /** *

The identifier of the set of featured results.

*/ inline FeaturedResultsSet& WithFeaturedResultsSetId(const Aws::String& value) { SetFeaturedResultsSetId(value); return *this;} /** *

The identifier of the set of featured results.

*/ inline FeaturedResultsSet& WithFeaturedResultsSetId(Aws::String&& value) { SetFeaturedResultsSetId(std::move(value)); return *this;} /** *

The identifier of the set of featured results.

*/ inline FeaturedResultsSet& WithFeaturedResultsSetId(const char* value) { SetFeaturedResultsSetId(value); return *this;} /** *

The name for the set of featured results.

*/ inline const Aws::String& GetFeaturedResultsSetName() const{ return m_featuredResultsSetName; } /** *

The name for the set of featured results.

*/ inline bool FeaturedResultsSetNameHasBeenSet() const { return m_featuredResultsSetNameHasBeenSet; } /** *

The name for the set of featured results.

*/ inline void SetFeaturedResultsSetName(const Aws::String& value) { m_featuredResultsSetNameHasBeenSet = true; m_featuredResultsSetName = value; } /** *

The name for the set of featured results.

*/ inline void SetFeaturedResultsSetName(Aws::String&& value) { m_featuredResultsSetNameHasBeenSet = true; m_featuredResultsSetName = std::move(value); } /** *

The name for the set of featured results.

*/ inline void SetFeaturedResultsSetName(const char* value) { m_featuredResultsSetNameHasBeenSet = true; m_featuredResultsSetName.assign(value); } /** *

The name for the set of featured results.

*/ inline FeaturedResultsSet& WithFeaturedResultsSetName(const Aws::String& value) { SetFeaturedResultsSetName(value); return *this;} /** *

The name for the set of featured results.

*/ inline FeaturedResultsSet& WithFeaturedResultsSetName(Aws::String&& value) { SetFeaturedResultsSetName(std::move(value)); return *this;} /** *

The name for the set of featured results.

*/ inline FeaturedResultsSet& WithFeaturedResultsSetName(const char* value) { SetFeaturedResultsSetName(value); return *this;} /** *

The description for the set of featured results.

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

The description for the set of featured results.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The description for the set of featured results.

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

The description for the set of featured results.

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

The description for the set of featured results.

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

The description for the set of featured results.

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

The description for the set of featured results.

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

The description for the set of featured results.

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

The current status of the set of featured results. When the value is * ACTIVE, featured results are ready for use. You can still configure * your settings before setting the status to ACTIVE. You can set the * status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet * API. The queries you specify for featured results must be unique per featured * results set for each index, whether the status is ACTIVE or * INACTIVE.

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

The current status of the set of featured results. When the value is * ACTIVE, featured results are ready for use. You can still configure * your settings before setting the status to ACTIVE. You can set the * status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet * API. The queries you specify for featured results must be unique per featured * results set for each index, whether the status is ACTIVE or * INACTIVE.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The current status of the set of featured results. When the value is * ACTIVE, featured results are ready for use. You can still configure * your settings before setting the status to ACTIVE. You can set the * status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet * API. The queries you specify for featured results must be unique per featured * results set for each index, whether the status is ACTIVE or * INACTIVE.

*/ inline void SetStatus(const FeaturedResultsSetStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The current status of the set of featured results. When the value is * ACTIVE, featured results are ready for use. You can still configure * your settings before setting the status to ACTIVE. You can set the * status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet * API. The queries you specify for featured results must be unique per featured * results set for each index, whether the status is ACTIVE or * INACTIVE.

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

The current status of the set of featured results. When the value is * ACTIVE, featured results are ready for use. You can still configure * your settings before setting the status to ACTIVE. You can set the * status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet * API. The queries you specify for featured results must be unique per featured * results set for each index, whether the status is ACTIVE or * INACTIVE.

*/ inline FeaturedResultsSet& WithStatus(const FeaturedResultsSetStatus& value) { SetStatus(value); return *this;} /** *

The current status of the set of featured results. When the value is * ACTIVE, featured results are ready for use. You can still configure * your settings before setting the status to ACTIVE. You can set the * status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet * API. The queries you specify for featured results must be unique per featured * results set for each index, whether the status is ACTIVE or * INACTIVE.

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

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline const Aws::Vector& GetQueryTexts() const{ return m_queryTexts; } /** *

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline bool QueryTextsHasBeenSet() const { return m_queryTextsHasBeenSet; } /** *

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline void SetQueryTexts(const Aws::Vector& value) { m_queryTextsHasBeenSet = true; m_queryTexts = value; } /** *

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline void SetQueryTexts(Aws::Vector&& value) { m_queryTextsHasBeenSet = true; m_queryTexts = std::move(value); } /** *

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& WithQueryTexts(const Aws::Vector& value) { SetQueryTexts(value); return *this;} /** *

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& WithQueryTexts(Aws::Vector&& value) { SetQueryTexts(std::move(value)); return *this;} /** *

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& AddQueryTexts(const Aws::String& value) { m_queryTextsHasBeenSet = true; m_queryTexts.push_back(value); return *this; } /** *

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& AddQueryTexts(Aws::String&& value) { m_queryTextsHasBeenSet = true; m_queryTexts.push_back(std::move(value)); return *this; } /** *

The list of queries for featuring results.

Specific queries are mapped * to specific documents for featuring in the results. If a query contains an exact * match, then one or more specific documents are featured in the results. The * exact match applies to the full query. For example, if you only specify * 'Kendra', queries such as 'How does kendra semantically rank results?' will not * render the featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& AddQueryTexts(const char* value) { m_queryTextsHasBeenSet = true; m_queryTexts.push_back(value); return *this; } /** *

The list of document IDs for the documents you want to feature at the top of * the search results page. You can use the Query API * to search for specific documents with their document IDs included in the result * items, or you can use the console.

You can add up to four featured * documents. You can request to increase this limit by contacting Support.

Specific queries * are mapped to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * results. The exact match applies to the full query. For example, if you only * specify 'Kendra', queries such as 'How does kendra semantically rank results?' * will not render the featured results. Featured results are designed for specific * queries, rather than queries that are too broad in scope.

*/ inline const Aws::Vector& GetFeaturedDocuments() const{ return m_featuredDocuments; } /** *

The list of document IDs for the documents you want to feature at the top of * the search results page. You can use the Query API * to search for specific documents with their document IDs included in the result * items, or you can use the console.

You can add up to four featured * documents. You can request to increase this limit by contacting Support.

Specific queries * are mapped to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * results. The exact match applies to the full query. For example, if you only * specify 'Kendra', queries such as 'How does kendra semantically rank results?' * will not render the featured results. Featured results are designed for specific * queries, rather than queries that are too broad in scope.

*/ inline bool FeaturedDocumentsHasBeenSet() const { return m_featuredDocumentsHasBeenSet; } /** *

The list of document IDs for the documents you want to feature at the top of * the search results page. You can use the Query API * to search for specific documents with their document IDs included in the result * items, or you can use the console.

You can add up to four featured * documents. You can request to increase this limit by contacting Support.

Specific queries * are mapped to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * results. The exact match applies to the full query. For example, if you only * specify 'Kendra', queries such as 'How does kendra semantically rank results?' * will not render the featured results. Featured results are designed for specific * queries, rather than queries that are too broad in scope.

*/ inline void SetFeaturedDocuments(const Aws::Vector& value) { m_featuredDocumentsHasBeenSet = true; m_featuredDocuments = value; } /** *

The list of document IDs for the documents you want to feature at the top of * the search results page. You can use the Query API * to search for specific documents with their document IDs included in the result * items, or you can use the console.

You can add up to four featured * documents. You can request to increase this limit by contacting Support.

Specific queries * are mapped to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * results. The exact match applies to the full query. For example, if you only * specify 'Kendra', queries such as 'How does kendra semantically rank results?' * will not render the featured results. Featured results are designed for specific * queries, rather than queries that are too broad in scope.

*/ inline void SetFeaturedDocuments(Aws::Vector&& value) { m_featuredDocumentsHasBeenSet = true; m_featuredDocuments = std::move(value); } /** *

The list of document IDs for the documents you want to feature at the top of * the search results page. You can use the Query API * to search for specific documents with their document IDs included in the result * items, or you can use the console.

You can add up to four featured * documents. You can request to increase this limit by contacting Support.

Specific queries * are mapped to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * results. The exact match applies to the full query. For example, if you only * specify 'Kendra', queries such as 'How does kendra semantically rank results?' * will not render the featured results. Featured results are designed for specific * queries, rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& WithFeaturedDocuments(const Aws::Vector& value) { SetFeaturedDocuments(value); return *this;} /** *

The list of document IDs for the documents you want to feature at the top of * the search results page. You can use the Query API * to search for specific documents with their document IDs included in the result * items, or you can use the console.

You can add up to four featured * documents. You can request to increase this limit by contacting Support.

Specific queries * are mapped to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * results. The exact match applies to the full query. For example, if you only * specify 'Kendra', queries such as 'How does kendra semantically rank results?' * will not render the featured results. Featured results are designed for specific * queries, rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& WithFeaturedDocuments(Aws::Vector&& value) { SetFeaturedDocuments(std::move(value)); return *this;} /** *

The list of document IDs for the documents you want to feature at the top of * the search results page. You can use the Query API * to search for specific documents with their document IDs included in the result * items, or you can use the console.

You can add up to four featured * documents. You can request to increase this limit by contacting Support.

Specific queries * are mapped to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * results. The exact match applies to the full query. For example, if you only * specify 'Kendra', queries such as 'How does kendra semantically rank results?' * will not render the featured results. Featured results are designed for specific * queries, rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& AddFeaturedDocuments(const FeaturedDocument& value) { m_featuredDocumentsHasBeenSet = true; m_featuredDocuments.push_back(value); return *this; } /** *

The list of document IDs for the documents you want to feature at the top of * the search results page. You can use the Query API * to search for specific documents with their document IDs included in the result * items, or you can use the console.

You can add up to four featured * documents. You can request to increase this limit by contacting Support.

Specific queries * are mapped to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * results. The exact match applies to the full query. For example, if you only * specify 'Kendra', queries such as 'How does kendra semantically rank results?' * will not render the featured results. Featured results are designed for specific * queries, rather than queries that are too broad in scope.

*/ inline FeaturedResultsSet& AddFeaturedDocuments(FeaturedDocument&& value) { m_featuredDocumentsHasBeenSet = true; m_featuredDocuments.push_back(std::move(value)); return *this; } /** *

The Unix timestamp when the set of featured results was last updated.

*/ inline long long GetLastUpdatedTimestamp() const{ return m_lastUpdatedTimestamp; } /** *

The Unix timestamp when the set of featured results was last updated.

*/ inline bool LastUpdatedTimestampHasBeenSet() const { return m_lastUpdatedTimestampHasBeenSet; } /** *

The Unix timestamp when the set of featured results was last updated.

*/ inline void SetLastUpdatedTimestamp(long long value) { m_lastUpdatedTimestampHasBeenSet = true; m_lastUpdatedTimestamp = value; } /** *

The Unix timestamp when the set of featured results was last updated.

*/ inline FeaturedResultsSet& WithLastUpdatedTimestamp(long long value) { SetLastUpdatedTimestamp(value); return *this;} /** *

The Unix timestamp when the set of featured results was created.

*/ inline long long GetCreationTimestamp() const{ return m_creationTimestamp; } /** *

The Unix timestamp when the set of featured results was created.

*/ inline bool CreationTimestampHasBeenSet() const { return m_creationTimestampHasBeenSet; } /** *

The Unix timestamp when the set of featured results was created.

*/ inline void SetCreationTimestamp(long long value) { m_creationTimestampHasBeenSet = true; m_creationTimestamp = value; } /** *

The Unix timestamp when the set of featured results was created.

*/ inline FeaturedResultsSet& WithCreationTimestamp(long long value) { SetCreationTimestamp(value); return *this;} private: Aws::String m_featuredResultsSetId; bool m_featuredResultsSetIdHasBeenSet = false; Aws::String m_featuredResultsSetName; bool m_featuredResultsSetNameHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; FeaturedResultsSetStatus m_status; bool m_statusHasBeenSet = false; Aws::Vector m_queryTexts; bool m_queryTextsHasBeenSet = false; Aws::Vector m_featuredDocuments; bool m_featuredDocumentsHasBeenSet = false; long long m_lastUpdatedTimestamp; bool m_lastUpdatedTimestampHasBeenSet = false; long long m_creationTimestamp; bool m_creationTimestampHasBeenSet = false; }; } // namespace Model } // namespace kendra } // namespace Aws