AWS SDK for C++  1.9.4
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::DocumentMetadataConfiguration Class Reference

#include <DocumentMetadataConfiguration.h>

Public Member Functions

 DocumentMetadataConfiguration ()
 
 DocumentMetadataConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
DocumentMetadataConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DocumentMetadataConfigurationWithName (const Aws::String &value)
 
DocumentMetadataConfigurationWithName (Aws::String &&value)
 
DocumentMetadataConfigurationWithName (const char *value)
 
const DocumentAttributeValueTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const DocumentAttributeValueType &value)
 
void SetType (DocumentAttributeValueType &&value)
 
DocumentMetadataConfigurationWithType (const DocumentAttributeValueType &value)
 
DocumentMetadataConfigurationWithType (DocumentAttributeValueType &&value)
 
const RelevanceGetRelevance () const
 
bool RelevanceHasBeenSet () const
 
void SetRelevance (const Relevance &value)
 
void SetRelevance (Relevance &&value)
 
DocumentMetadataConfigurationWithRelevance (const Relevance &value)
 
DocumentMetadataConfigurationWithRelevance (Relevance &&value)
 
const SearchGetSearch () const
 
bool SearchHasBeenSet () const
 
void SetSearch (const Search &value)
 
void SetSearch (Search &&value)
 
DocumentMetadataConfigurationWithSearch (const Search &value)
 
DocumentMetadataConfigurationWithSearch (Search &&value)
 

Detailed Description

Specifies the properties of a custom index field.

See Also:


AWS API Reference

Definition at line 35 of file DocumentMetadataConfiguration.h.

Constructor & Destructor Documentation

◆ DocumentMetadataConfiguration() [1/2]

Aws::kendra::Model::DocumentMetadataConfiguration::DocumentMetadataConfiguration ( )

◆ DocumentMetadataConfiguration() [2/2]

Aws::kendra::Model::DocumentMetadataConfiguration::DocumentMetadataConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetName()

const Aws::String& Aws::kendra::Model::DocumentMetadataConfiguration::GetName ( ) const
inline

The name of the index field.

Definition at line 47 of file DocumentMetadataConfiguration.h.

◆ GetRelevance()

const Relevance& Aws::kendra::Model::DocumentMetadataConfiguration::GetRelevance ( ) const
inline

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

Definition at line 120 of file DocumentMetadataConfiguration.h.

◆ GetSearch()

const Search& Aws::kendra::Model::DocumentMetadataConfiguration::GetSearch ( ) const
inline

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

Definition at line 156 of file DocumentMetadataConfiguration.h.

◆ GetType()

const DocumentAttributeValueType& Aws::kendra::Model::DocumentMetadataConfiguration::GetType ( ) const
inline

The data type of the index field.

Definition at line 88 of file DocumentMetadataConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::DocumentMetadataConfiguration::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::kendra::Model::DocumentMetadataConfiguration::NameHasBeenSet ( ) const
inline

The name of the index field.

Definition at line 52 of file DocumentMetadataConfiguration.h.

◆ operator=()

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RelevanceHasBeenSet()

bool Aws::kendra::Model::DocumentMetadataConfiguration::RelevanceHasBeenSet ( ) const
inline

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

Definition at line 126 of file DocumentMetadataConfiguration.h.

◆ SearchHasBeenSet()

bool Aws::kendra::Model::DocumentMetadataConfiguration::SearchHasBeenSet ( ) const
inline

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

Definition at line 161 of file DocumentMetadataConfiguration.h.

◆ SetName() [1/3]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetName ( Aws::String &&  value)
inline

The name of the index field.

Definition at line 62 of file DocumentMetadataConfiguration.h.

◆ SetName() [2/3]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetName ( const Aws::String value)
inline

The name of the index field.

Definition at line 57 of file DocumentMetadataConfiguration.h.

◆ SetName() [3/3]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetName ( const char *  value)
inline

The name of the index field.

Definition at line 67 of file DocumentMetadataConfiguration.h.

◆ SetRelevance() [1/2]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetRelevance ( const Relevance value)
inline

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

Definition at line 132 of file DocumentMetadataConfiguration.h.

◆ SetRelevance() [2/2]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetRelevance ( Relevance &&  value)
inline

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

Definition at line 138 of file DocumentMetadataConfiguration.h.

◆ SetSearch() [1/2]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetSearch ( const Search value)
inline

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

Definition at line 166 of file DocumentMetadataConfiguration.h.

◆ SetSearch() [2/2]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetSearch ( Search &&  value)
inline

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

Definition at line 171 of file DocumentMetadataConfiguration.h.

◆ SetType() [1/2]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetType ( const DocumentAttributeValueType value)
inline

The data type of the index field.

Definition at line 98 of file DocumentMetadataConfiguration.h.

◆ SetType() [2/2]

void Aws::kendra::Model::DocumentMetadataConfiguration::SetType ( DocumentAttributeValueType &&  value)
inline

The data type of the index field.

Definition at line 103 of file DocumentMetadataConfiguration.h.

◆ TypeHasBeenSet()

bool Aws::kendra::Model::DocumentMetadataConfiguration::TypeHasBeenSet ( ) const
inline

The data type of the index field.

Definition at line 93 of file DocumentMetadataConfiguration.h.

◆ WithName() [1/3]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithName ( Aws::String &&  value)
inline

The name of the index field.

Definition at line 77 of file DocumentMetadataConfiguration.h.

◆ WithName() [2/3]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithName ( const Aws::String value)
inline

The name of the index field.

Definition at line 72 of file DocumentMetadataConfiguration.h.

◆ WithName() [3/3]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithName ( const char *  value)
inline

The name of the index field.

Definition at line 82 of file DocumentMetadataConfiguration.h.

◆ WithRelevance() [1/2]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithRelevance ( const Relevance value)
inline

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

Definition at line 144 of file DocumentMetadataConfiguration.h.

◆ WithRelevance() [2/2]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithRelevance ( Relevance &&  value)
inline

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

Definition at line 150 of file DocumentMetadataConfiguration.h.

◆ WithSearch() [1/2]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithSearch ( const Search value)
inline

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

Definition at line 176 of file DocumentMetadataConfiguration.h.

◆ WithSearch() [2/2]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithSearch ( Search &&  value)
inline

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

Definition at line 181 of file DocumentMetadataConfiguration.h.

◆ WithType() [1/2]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithType ( const DocumentAttributeValueType value)
inline

The data type of the index field.

Definition at line 108 of file DocumentMetadataConfiguration.h.

◆ WithType() [2/2]

DocumentMetadataConfiguration& Aws::kendra::Model::DocumentMetadataConfiguration::WithType ( DocumentAttributeValueType &&  value)
inline

The data type of the index field.

Definition at line 113 of file DocumentMetadataConfiguration.h.


The documentation for this class was generated from the following file: