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

#include <TextOptions.h>

Public Member Functions

 TextOptions ()
 
 TextOptions (const Aws::Utils::Xml::XmlNode &xmlNode)
 
TextOptionsoperator= (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::StringGetDefaultValue () const
 
bool DefaultValueHasBeenSet () const
 
void SetDefaultValue (const Aws::String &value)
 
void SetDefaultValue (Aws::String &&value)
 
void SetDefaultValue (const char *value)
 
TextOptionsWithDefaultValue (const Aws::String &value)
 
TextOptionsWithDefaultValue (Aws::String &&value)
 
TextOptionsWithDefaultValue (const char *value)
 
const Aws::StringGetSourceField () const
 
bool SourceFieldHasBeenSet () const
 
void SetSourceField (const Aws::String &value)
 
void SetSourceField (Aws::String &&value)
 
void SetSourceField (const char *value)
 
TextOptionsWithSourceField (const Aws::String &value)
 
TextOptionsWithSourceField (Aws::String &&value)
 
TextOptionsWithSourceField (const char *value)
 
bool GetReturnEnabled () const
 
bool ReturnEnabledHasBeenSet () const
 
void SetReturnEnabled (bool value)
 
TextOptionsWithReturnEnabled (bool value)
 
bool GetSortEnabled () const
 
bool SortEnabledHasBeenSet () const
 
void SetSortEnabled (bool value)
 
TextOptionsWithSortEnabled (bool value)
 
bool GetHighlightEnabled () const
 
bool HighlightEnabledHasBeenSet () const
 
void SetHighlightEnabled (bool value)
 
TextOptionsWithHighlightEnabled (bool value)
 
const Aws::StringGetAnalysisScheme () const
 
bool AnalysisSchemeHasBeenSet () const
 
void SetAnalysisScheme (const Aws::String &value)
 
void SetAnalysisScheme (Aws::String &&value)
 
void SetAnalysisScheme (const char *value)
 
TextOptionsWithAnalysisScheme (const Aws::String &value)
 
TextOptionsWithAnalysisScheme (Aws::String &&value)
 
TextOptionsWithAnalysisScheme (const char *value)
 

Detailed Description

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

See Also:

AWS API Reference

Definition at line 33 of file TextOptions.h.

Constructor & Destructor Documentation

◆ TextOptions() [1/2]

Aws::CloudSearch::Model::TextOptions::TextOptions ( )

◆ TextOptions() [2/2]

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

Member Function Documentation

◆ AnalysisSchemeHasBeenSet()

bool Aws::CloudSearch::Model::TextOptions::AnalysisSchemeHasBeenSet ( ) const
inline

The name of an analysis scheme for a text field.

Definition at line 181 of file TextOptions.h.

◆ DefaultValueHasBeenSet()

bool Aws::CloudSearch::Model::TextOptions::DefaultValueHasBeenSet ( ) const
inline

A value to use for the field if the field isn't specified for a document.

Definition at line 52 of file TextOptions.h.

◆ GetAnalysisScheme()

const Aws::String& Aws::CloudSearch::Model::TextOptions::GetAnalysisScheme ( ) const
inline

The name of an analysis scheme for a text field.

Definition at line 176 of file TextOptions.h.

◆ GetDefaultValue()

const Aws::String& Aws::CloudSearch::Model::TextOptions::GetDefaultValue ( ) const
inline

A value to use for the field if the field isn't specified for a document.

Definition at line 47 of file TextOptions.h.

◆ GetHighlightEnabled()

bool Aws::CloudSearch::Model::TextOptions::GetHighlightEnabled ( ) const
inline

Whether highlights can be returned for the field.

Definition at line 155 of file TextOptions.h.

◆ GetReturnEnabled()

bool Aws::CloudSearch::Model::TextOptions::GetReturnEnabled ( ) const
inline

Whether the contents of the field can be returned in the search results.

Definition at line 113 of file TextOptions.h.

◆ GetSortEnabled()

bool Aws::CloudSearch::Model::TextOptions::GetSortEnabled ( ) const
inline

Whether the field can be used to sort the search results.

Definition at line 134 of file TextOptions.h.

◆ GetSourceField()

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

Definition at line 86 of file TextOptions.h.

◆ HighlightEnabledHasBeenSet()

bool Aws::CloudSearch::Model::TextOptions::HighlightEnabledHasBeenSet ( ) const
inline

Whether highlights can be returned for the field.

Definition at line 160 of file TextOptions.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ ReturnEnabledHasBeenSet()

bool Aws::CloudSearch::Model::TextOptions::ReturnEnabledHasBeenSet ( ) const
inline

Whether the contents of the field can be returned in the search results.

Definition at line 118 of file TextOptions.h.

◆ SetAnalysisScheme() [1/3]

void Aws::CloudSearch::Model::TextOptions::SetAnalysisScheme ( const Aws::String value)
inline

The name of an analysis scheme for a text field.

Definition at line 186 of file TextOptions.h.

◆ SetAnalysisScheme() [2/3]

void Aws::CloudSearch::Model::TextOptions::SetAnalysisScheme ( Aws::String &&  value)
inline

The name of an analysis scheme for a text field.

Definition at line 191 of file TextOptions.h.

◆ SetAnalysisScheme() [3/3]

void Aws::CloudSearch::Model::TextOptions::SetAnalysisScheme ( const char *  value)
inline

The name of an analysis scheme for a text field.

Definition at line 196 of file TextOptions.h.

◆ SetDefaultValue() [1/3]

void Aws::CloudSearch::Model::TextOptions::SetDefaultValue ( const Aws::String value)
inline

A value to use for the field if the field isn't specified for a document.

Definition at line 57 of file TextOptions.h.

◆ SetDefaultValue() [2/3]

void Aws::CloudSearch::Model::TextOptions::SetDefaultValue ( Aws::String &&  value)
inline

A value to use for the field if the field isn't specified for a document.

Definition at line 62 of file TextOptions.h.

◆ SetDefaultValue() [3/3]

void Aws::CloudSearch::Model::TextOptions::SetDefaultValue ( const char *  value)
inline

A value to use for the field if the field isn't specified for a document.

Definition at line 67 of file TextOptions.h.

◆ SetHighlightEnabled()

void Aws::CloudSearch::Model::TextOptions::SetHighlightEnabled ( bool  value)
inline

Whether highlights can be returned for the field.

Definition at line 165 of file TextOptions.h.

◆ SetReturnEnabled()

void Aws::CloudSearch::Model::TextOptions::SetReturnEnabled ( bool  value)
inline

Whether the contents of the field can be returned in the search results.

Definition at line 123 of file TextOptions.h.

◆ SetSortEnabled()

void Aws::CloudSearch::Model::TextOptions::SetSortEnabled ( bool  value)
inline

Whether the field can be used to sort the search results.

Definition at line 144 of file TextOptions.h.

◆ SetSourceField() [1/3]

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

Definition at line 92 of file TextOptions.h.

◆ SetSourceField() [2/3]

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

Definition at line 95 of file TextOptions.h.

◆ SetSourceField() [3/3]

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

Definition at line 98 of file TextOptions.h.

◆ SortEnabledHasBeenSet()

bool Aws::CloudSearch::Model::TextOptions::SortEnabledHasBeenSet ( ) const
inline

Whether the field can be used to sort the search results.

Definition at line 139 of file TextOptions.h.

◆ SourceFieldHasBeenSet()

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

Definition at line 89 of file TextOptions.h.

◆ WithAnalysisScheme() [1/3]

TextOptions& Aws::CloudSearch::Model::TextOptions::WithAnalysisScheme ( const Aws::String value)
inline

The name of an analysis scheme for a text field.

Definition at line 201 of file TextOptions.h.

◆ WithAnalysisScheme() [2/3]

TextOptions& Aws::CloudSearch::Model::TextOptions::WithAnalysisScheme ( Aws::String &&  value)
inline

The name of an analysis scheme for a text field.

Definition at line 206 of file TextOptions.h.

◆ WithAnalysisScheme() [3/3]

TextOptions& Aws::CloudSearch::Model::TextOptions::WithAnalysisScheme ( const char *  value)
inline

The name of an analysis scheme for a text field.

Definition at line 211 of file TextOptions.h.

◆ WithDefaultValue() [1/3]

TextOptions& Aws::CloudSearch::Model::TextOptions::WithDefaultValue ( const Aws::String value)
inline

A value to use for the field if the field isn't specified for a document.

Definition at line 72 of file TextOptions.h.

◆ WithDefaultValue() [2/3]

TextOptions& Aws::CloudSearch::Model::TextOptions::WithDefaultValue ( Aws::String &&  value)
inline

A value to use for the field if the field isn't specified for a document.

Definition at line 77 of file TextOptions.h.

◆ WithDefaultValue() [3/3]

TextOptions& Aws::CloudSearch::Model::TextOptions::WithDefaultValue ( const char *  value)
inline

A value to use for the field if the field isn't specified for a document.

Definition at line 82 of file TextOptions.h.

◆ WithHighlightEnabled()

TextOptions& Aws::CloudSearch::Model::TextOptions::WithHighlightEnabled ( bool  value)
inline

Whether highlights can be returned for the field.

Definition at line 170 of file TextOptions.h.

◆ WithReturnEnabled()

TextOptions& Aws::CloudSearch::Model::TextOptions::WithReturnEnabled ( bool  value)
inline

Whether the contents of the field can be returned in the search results.

Definition at line 128 of file TextOptions.h.

◆ WithSortEnabled()

TextOptions& Aws::CloudSearch::Model::TextOptions::WithSortEnabled ( bool  value)
inline

Whether the field can be used to sort the search results.

Definition at line 149 of file TextOptions.h.

◆ WithSourceField() [1/3]

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

Definition at line 101 of file TextOptions.h.

◆ WithSourceField() [2/3]

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

Definition at line 104 of file TextOptions.h.

◆ WithSourceField() [3/3]

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

Definition at line 107 of file TextOptions.h.


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