AWS SDK for C++  1.8.99
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudSearch::Model::DocumentSuggesterOptions Class Reference

#include <DocumentSuggesterOptions.h>

Public Member Functions

 DocumentSuggesterOptions ()
 
 DocumentSuggesterOptions (const Aws::Utils::Xml::XmlNode &xmlNode)
 
DocumentSuggesterOptionsoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetSourceField () const
 
bool SourceFieldHasBeenSet () const
 
void SetSourceField (const Aws::String &value)
 
void SetSourceField (Aws::String &&value)
 
void SetSourceField (const char *value)
 
DocumentSuggesterOptionsWithSourceField (const Aws::String &value)
 
DocumentSuggesterOptionsWithSourceField (Aws::String &&value)
 
DocumentSuggesterOptionsWithSourceField (const char *value)
 
const SuggesterFuzzyMatchingGetFuzzyMatching () const
 
bool FuzzyMatchingHasBeenSet () const
 
void SetFuzzyMatching (const SuggesterFuzzyMatching &value)
 
void SetFuzzyMatching (SuggesterFuzzyMatching &&value)
 
DocumentSuggesterOptionsWithFuzzyMatching (const SuggesterFuzzyMatching &value)
 
DocumentSuggesterOptionsWithFuzzyMatching (SuggesterFuzzyMatching &&value)
 
const Aws::StringGetSortExpression () const
 
bool SortExpressionHasBeenSet () const
 
void SetSortExpression (const Aws::String &value)
 
void SetSortExpression (Aws::String &&value)
 
void SetSortExpression (const char *value)
 
DocumentSuggesterOptionsWithSortExpression (const Aws::String &value)
 
DocumentSuggesterOptionsWithSortExpression (Aws::String &&value)
 
DocumentSuggesterOptionsWithSortExpression (const char *value)
 

Detailed Description

Options for a search suggester.

See Also:

AWS API Reference

Definition at line 32 of file DocumentSuggesterOptions.h.

Constructor & Destructor Documentation

◆ DocumentSuggesterOptions() [1/2]

Aws::CloudSearch::Model::DocumentSuggesterOptions::DocumentSuggesterOptions ( )

◆ DocumentSuggesterOptions() [2/2]

Aws::CloudSearch::Model::DocumentSuggesterOptions::DocumentSuggesterOptions ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ FuzzyMatchingHasBeenSet()

bool Aws::CloudSearch::Model::DocumentSuggesterOptions::FuzzyMatchingHasBeenSet ( ) const
inline

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Definition at line 100 of file DocumentSuggesterOptions.h.

◆ GetFuzzyMatching()

const SuggesterFuzzyMatching& Aws::CloudSearch::Model::DocumentSuggesterOptions::GetFuzzyMatching ( ) const
inline

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Definition at line 91 of file DocumentSuggesterOptions.h.

◆ GetSortExpression()

const Aws::String& Aws::CloudSearch::Model::DocumentSuggesterOptions::GetSortExpression ( ) const
inline

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Definition at line 148 of file DocumentSuggesterOptions.h.

◆ GetSourceField()

const Aws::String& Aws::CloudSearch::Model::DocumentSuggesterOptions::GetSourceField ( ) const
inline

The name of the index field you want to use for suggestions.

Definition at line 46 of file DocumentSuggesterOptions.h.

◆ operator=()

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ SetFuzzyMatching() [1/2]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::SetFuzzyMatching ( const SuggesterFuzzyMatching value)
inline

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Definition at line 109 of file DocumentSuggesterOptions.h.

◆ SetFuzzyMatching() [2/2]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::SetFuzzyMatching ( SuggesterFuzzyMatching &&  value)
inline

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Definition at line 118 of file DocumentSuggesterOptions.h.

◆ SetSortExpression() [1/3]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::SetSortExpression ( const Aws::String value)
inline

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Definition at line 170 of file DocumentSuggesterOptions.h.

◆ SetSortExpression() [2/3]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::SetSortExpression ( Aws::String &&  value)
inline

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Definition at line 181 of file DocumentSuggesterOptions.h.

◆ SetSortExpression() [3/3]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::SetSortExpression ( const char *  value)
inline

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Definition at line 192 of file DocumentSuggesterOptions.h.

◆ SetSourceField() [1/3]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::SetSourceField ( const Aws::String value)
inline

The name of the index field you want to use for suggestions.

Definition at line 56 of file DocumentSuggesterOptions.h.

◆ SetSourceField() [2/3]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::SetSourceField ( Aws::String &&  value)
inline

The name of the index field you want to use for suggestions.

Definition at line 61 of file DocumentSuggesterOptions.h.

◆ SetSourceField() [3/3]

void Aws::CloudSearch::Model::DocumentSuggesterOptions::SetSourceField ( const char *  value)
inline

The name of the index field you want to use for suggestions.

Definition at line 66 of file DocumentSuggesterOptions.h.

◆ SortExpressionHasBeenSet()

bool Aws::CloudSearch::Model::DocumentSuggesterOptions::SortExpressionHasBeenSet ( ) const
inline

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Definition at line 159 of file DocumentSuggesterOptions.h.

◆ SourceFieldHasBeenSet()

bool Aws::CloudSearch::Model::DocumentSuggesterOptions::SourceFieldHasBeenSet ( ) const
inline

The name of the index field you want to use for suggestions.

Definition at line 51 of file DocumentSuggesterOptions.h.

◆ WithFuzzyMatching() [1/2]

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::WithFuzzyMatching ( const SuggesterFuzzyMatching value)
inline

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Definition at line 127 of file DocumentSuggesterOptions.h.

◆ WithFuzzyMatching() [2/2]

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::WithFuzzyMatching ( SuggesterFuzzyMatching &&  value)
inline

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Definition at line 136 of file DocumentSuggesterOptions.h.

◆ WithSortExpression() [1/3]

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::WithSortExpression ( const Aws::String value)
inline

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Definition at line 203 of file DocumentSuggesterOptions.h.

◆ WithSortExpression() [2/3]

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::WithSortExpression ( Aws::String &&  value)
inline

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Definition at line 214 of file DocumentSuggesterOptions.h.

◆ WithSortExpression() [3/3]

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::WithSortExpression ( const char *  value)
inline

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Definition at line 225 of file DocumentSuggesterOptions.h.

◆ WithSourceField() [1/3]

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::WithSourceField ( const Aws::String value)
inline

The name of the index field you want to use for suggestions.

Definition at line 71 of file DocumentSuggesterOptions.h.

◆ WithSourceField() [2/3]

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::WithSourceField ( Aws::String &&  value)
inline

The name of the index field you want to use for suggestions.

Definition at line 76 of file DocumentSuggesterOptions.h.

◆ WithSourceField() [3/3]

DocumentSuggesterOptions& Aws::CloudSearch::Model::DocumentSuggesterOptions::WithSourceField ( const char *  value)
inline

The name of the index field you want to use for suggestions.

Definition at line 81 of file DocumentSuggesterOptions.h.


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