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

#include <TextArrayOptions.h>

Public Member Functions

 TextArrayOptions ()
 
 TextArrayOptions (const Aws::Utils::Xml::XmlNode &xmlNode)
 
TextArrayOptionsoperator= (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)
 
TextArrayOptionsWithDefaultValue (const Aws::String &value)
 
TextArrayOptionsWithDefaultValue (Aws::String &&value)
 
TextArrayOptionsWithDefaultValue (const char *value)
 
const Aws::StringGetSourceFields () const
 
bool SourceFieldsHasBeenSet () const
 
void SetSourceFields (const Aws::String &value)
 
void SetSourceFields (Aws::String &&value)
 
void SetSourceFields (const char *value)
 
TextArrayOptionsWithSourceFields (const Aws::String &value)
 
TextArrayOptionsWithSourceFields (Aws::String &&value)
 
TextArrayOptionsWithSourceFields (const char *value)
 
bool GetReturnEnabled () const
 
bool ReturnEnabledHasBeenSet () const
 
void SetReturnEnabled (bool value)
 
TextArrayOptionsWithReturnEnabled (bool value)
 
bool GetHighlightEnabled () const
 
bool HighlightEnabledHasBeenSet () const
 
void SetHighlightEnabled (bool value)
 
TextArrayOptionsWithHighlightEnabled (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)
 
TextArrayOptionsWithAnalysisScheme (const Aws::String &value)
 
TextArrayOptionsWithAnalysisScheme (Aws::String &&value)
 
TextArrayOptionsWithAnalysisScheme (const char *value)
 

Detailed Description

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

See Also:

AWS API Reference

Definition at line 34 of file TextArrayOptions.h.

Constructor & Destructor Documentation

◆ TextArrayOptions() [1/2]

Aws::CloudSearch::Model::TextArrayOptions::TextArrayOptions ( )

◆ TextArrayOptions() [2/2]

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

Member Function Documentation

◆ AnalysisSchemeHasBeenSet()

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

The name of an analysis scheme for a text-array field.

Definition at line 177 of file TextArrayOptions.h.

◆ DefaultValueHasBeenSet()

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

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

Definition at line 53 of file TextArrayOptions.h.

◆ GetAnalysisScheme()

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

The name of an analysis scheme for a text-array field.

Definition at line 172 of file TextArrayOptions.h.

◆ GetDefaultValue()

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

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

Definition at line 48 of file TextArrayOptions.h.

◆ GetHighlightEnabled()

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

Whether highlights can be returned for the field.

Definition at line 151 of file TextArrayOptions.h.

◆ GetReturnEnabled()

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

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

Definition at line 130 of file TextArrayOptions.h.

◆ GetSourceFields()

const Aws::String& Aws::CloudSearch::Model::TextArrayOptions::GetSourceFields ( ) const
inline

A list of source fields to map to the field.

Definition at line 89 of file TextArrayOptions.h.

◆ HighlightEnabledHasBeenSet()

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

Whether highlights can be returned for the field.

Definition at line 156 of file TextArrayOptions.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ ReturnEnabledHasBeenSet()

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

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

Definition at line 135 of file TextArrayOptions.h.

◆ SetAnalysisScheme() [1/3]

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

The name of an analysis scheme for a text-array field.

Definition at line 182 of file TextArrayOptions.h.

◆ SetAnalysisScheme() [2/3]

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

The name of an analysis scheme for a text-array field.

Definition at line 187 of file TextArrayOptions.h.

◆ SetAnalysisScheme() [3/3]

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

The name of an analysis scheme for a text-array field.

Definition at line 192 of file TextArrayOptions.h.

◆ SetDefaultValue() [1/3]

void Aws::CloudSearch::Model::TextArrayOptions::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 58 of file TextArrayOptions.h.

◆ SetDefaultValue() [2/3]

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

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

Definition at line 63 of file TextArrayOptions.h.

◆ SetDefaultValue() [3/3]

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

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

Definition at line 68 of file TextArrayOptions.h.

◆ SetHighlightEnabled()

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

Whether highlights can be returned for the field.

Definition at line 161 of file TextArrayOptions.h.

◆ SetReturnEnabled()

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

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

Definition at line 140 of file TextArrayOptions.h.

◆ SetSourceFields() [1/3]

void Aws::CloudSearch::Model::TextArrayOptions::SetSourceFields ( const Aws::String value)
inline

A list of source fields to map to the field.

Definition at line 99 of file TextArrayOptions.h.

◆ SetSourceFields() [2/3]

void Aws::CloudSearch::Model::TextArrayOptions::SetSourceFields ( Aws::String &&  value)
inline

A list of source fields to map to the field.

Definition at line 104 of file TextArrayOptions.h.

◆ SetSourceFields() [3/3]

void Aws::CloudSearch::Model::TextArrayOptions::SetSourceFields ( const char *  value)
inline

A list of source fields to map to the field.

Definition at line 109 of file TextArrayOptions.h.

◆ SourceFieldsHasBeenSet()

bool Aws::CloudSearch::Model::TextArrayOptions::SourceFieldsHasBeenSet ( ) const
inline

A list of source fields to map to the field.

Definition at line 94 of file TextArrayOptions.h.

◆ WithAnalysisScheme() [1/3]

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

The name of an analysis scheme for a text-array field.

Definition at line 197 of file TextArrayOptions.h.

◆ WithAnalysisScheme() [2/3]

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

The name of an analysis scheme for a text-array field.

Definition at line 202 of file TextArrayOptions.h.

◆ WithAnalysisScheme() [3/3]

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

The name of an analysis scheme for a text-array field.

Definition at line 207 of file TextArrayOptions.h.

◆ WithDefaultValue() [1/3]

TextArrayOptions& Aws::CloudSearch::Model::TextArrayOptions::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 73 of file TextArrayOptions.h.

◆ WithDefaultValue() [2/3]

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

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

Definition at line 78 of file TextArrayOptions.h.

◆ WithDefaultValue() [3/3]

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

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

Definition at line 83 of file TextArrayOptions.h.

◆ WithHighlightEnabled()

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

Whether highlights can be returned for the field.

Definition at line 166 of file TextArrayOptions.h.

◆ WithReturnEnabled()

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

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

Definition at line 145 of file TextArrayOptions.h.

◆ WithSourceFields() [1/3]

TextArrayOptions& Aws::CloudSearch::Model::TextArrayOptions::WithSourceFields ( const Aws::String value)
inline

A list of source fields to map to the field.

Definition at line 114 of file TextArrayOptions.h.

◆ WithSourceFields() [2/3]

TextArrayOptions& Aws::CloudSearch::Model::TextArrayOptions::WithSourceFields ( Aws::String &&  value)
inline

A list of source fields to map to the field.

Definition at line 119 of file TextArrayOptions.h.

◆ WithSourceFields() [3/3]

TextArrayOptions& Aws::CloudSearch::Model::TextArrayOptions::WithSourceFields ( const char *  value)
inline

A list of source fields to map to the field.

Definition at line 124 of file TextArrayOptions.h.


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