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

#include <Search.h>

Public Member Functions

 Search ()
 
 Search (Aws::Utils::Json::JsonView jsonValue)
 
Searchoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetFacetable () const
 
bool FacetableHasBeenSet () const
 
void SetFacetable (bool value)
 
SearchWithFacetable (bool value)
 
bool GetSearchable () const
 
bool SearchableHasBeenSet () const
 
void SetSearchable (bool value)
 
SearchWithSearchable (bool value)
 
bool GetDisplayable () const
 
bool DisplayableHasBeenSet () const
 
void SetDisplayable (bool value)
 
SearchWithDisplayable (bool value)
 
bool GetSortable () const
 
bool SortableHasBeenSet () const
 
void SetSortable (bool value)
 
SearchWithSortable (bool value)
 

Detailed Description

Provides information about how a custom index field is used during a search.

See Also:

AWS API Reference

Definition at line 30 of file Search.h.

Constructor & Destructor Documentation

◆ Search() [1/2]

Aws::kendra::Model::Search::Search ( )

◆ Search() [2/2]

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

Member Function Documentation

◆ DisplayableHasBeenSet()

bool Aws::kendra::Model::Search::DisplayableHasBeenSet ( ) const
inline

Determines whether the field is returned in the query response. The default is true.

Definition at line 111 of file Search.h.

◆ FacetableHasBeenSet()

bool Aws::kendra::Model::Search::FacetableHasBeenSet ( ) const
inline

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

Definition at line 49 of file Search.h.

◆ GetDisplayable()

bool Aws::kendra::Model::Search::GetDisplayable ( ) const
inline

Determines whether the field is returned in the query response. The default is true.

Definition at line 105 of file Search.h.

◆ GetFacetable()

bool Aws::kendra::Model::Search::GetFacetable ( ) const
inline

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

Definition at line 43 of file Search.h.

◆ GetSearchable()

bool Aws::kendra::Model::Search::GetSearchable ( ) const
inline

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

Definition at line 71 of file Search.h.

◆ GetSortable()

bool Aws::kendra::Model::Search::GetSortable ( ) const
inline

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Definition at line 132 of file Search.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SearchableHasBeenSet()

bool Aws::kendra::Model::Search::SearchableHasBeenSet ( ) const
inline

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

Definition at line 80 of file Search.h.

◆ SetDisplayable()

void Aws::kendra::Model::Search::SetDisplayable ( bool  value)
inline

Determines whether the field is returned in the query response. The default is true.

Definition at line 117 of file Search.h.

◆ SetFacetable()

void Aws::kendra::Model::Search::SetFacetable ( bool  value)
inline

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

Definition at line 55 of file Search.h.

◆ SetSearchable()

void Aws::kendra::Model::Search::SetSearchable ( bool  value)
inline

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

Definition at line 89 of file Search.h.

◆ SetSortable()

void Aws::kendra::Model::Search::SetSortable ( bool  value)
inline

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Definition at line 148 of file Search.h.

◆ SortableHasBeenSet()

bool Aws::kendra::Model::Search::SortableHasBeenSet ( ) const
inline

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Definition at line 140 of file Search.h.

◆ WithDisplayable()

Search& Aws::kendra::Model::Search::WithDisplayable ( bool  value)
inline

Determines whether the field is returned in the query response. The default is true.

Definition at line 123 of file Search.h.

◆ WithFacetable()

Search& Aws::kendra::Model::Search::WithFacetable ( bool  value)
inline

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

Definition at line 61 of file Search.h.

◆ WithSearchable()

Search& Aws::kendra::Model::Search::WithSearchable ( bool  value)
inline

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

Definition at line 98 of file Search.h.

◆ WithSortable()

Search& Aws::kendra::Model::Search::WithSortable ( bool  value)
inline

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Definition at line 156 of file Search.h.


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