/** * 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 { /** *

Specifies the properties, such as relevance tuning and searchability, of an * index field.

See Also:

AWS * API Reference

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

The name of the index field.

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

The name of the index field.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the index field.

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

The name of the index field.

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

The name of the index field.

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

The name of the index field.

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

The name of the index field.

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

The name of the index field.

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

The data type of the index field.

*/ inline const DocumentAttributeValueType& GetType() const{ return m_type; } /** *

The data type of the index field.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

The data type of the index field.

*/ inline void SetType(const DocumentAttributeValueType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

The data type of the index field.

*/ inline void SetType(DocumentAttributeValueType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

The data type of the index field.

*/ inline DocumentMetadataConfiguration& WithType(const DocumentAttributeValueType& value) { SetType(value); return *this;} /** *

The data type of the index field.

*/ inline DocumentMetadataConfiguration& WithType(DocumentAttributeValueType&& value) { SetType(std::move(value)); return *this;} /** *

Provides tuning parameters to determine how the field affects the search * results.

*/ inline const Relevance& GetRelevance() const{ return m_relevance; } /** *

Provides tuning parameters to determine how the field affects the search * results.

*/ inline bool RelevanceHasBeenSet() const { return m_relevanceHasBeenSet; } /** *

Provides tuning parameters to determine how the field affects the search * results.

*/ inline void SetRelevance(const Relevance& value) { m_relevanceHasBeenSet = true; m_relevance = value; } /** *

Provides tuning parameters to determine how the field affects the search * results.

*/ inline void SetRelevance(Relevance&& value) { m_relevanceHasBeenSet = true; m_relevance = std::move(value); } /** *

Provides tuning parameters to determine how the field affects the search * results.

*/ inline DocumentMetadataConfiguration& WithRelevance(const Relevance& value) { SetRelevance(value); return *this;} /** *

Provides tuning parameters to determine how the field affects the search * results.

*/ inline DocumentMetadataConfiguration& WithRelevance(Relevance&& value) { SetRelevance(std::move(value)); return *this;} /** *

Provides information about how the field is used during a search.

*/ inline const Search& GetSearch() const{ return m_search; } /** *

Provides information about how the field is used during a search.

*/ inline bool SearchHasBeenSet() const { return m_searchHasBeenSet; } /** *

Provides information about how the field is used during a search.

*/ inline void SetSearch(const Search& value) { m_searchHasBeenSet = true; m_search = value; } /** *

Provides information about how the field is used during a search.

*/ inline void SetSearch(Search&& value) { m_searchHasBeenSet = true; m_search = std::move(value); } /** *

Provides information about how the field is used during a search.

*/ inline DocumentMetadataConfiguration& WithSearch(const Search& value) { SetSearch(value); return *this;} /** *

Provides information about how the field is used during a search.

*/ inline DocumentMetadataConfiguration& WithSearch(Search&& value) { SetSearch(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; DocumentAttributeValueType m_type; bool m_typeHasBeenSet = false; Relevance m_relevance; bool m_relevanceHasBeenSet = false; Search m_search; bool m_searchHasBeenSet = false; }; } // namespace Model } // namespace kendra } // namespace Aws