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

#include <DateOptions.h>

Public Member Functions

 DateOptions ()
 
 DateOptions (const Aws::Utils::Xml::XmlNode &xmlNode)
 
DateOptionsoperator= (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)
 
DateOptionsWithDefaultValue (const Aws::String &value)
 
DateOptionsWithDefaultValue (Aws::String &&value)
 
DateOptionsWithDefaultValue (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)
 
DateOptionsWithSourceField (const Aws::String &value)
 
DateOptionsWithSourceField (Aws::String &&value)
 
DateOptionsWithSourceField (const char *value)
 
bool GetFacetEnabled () const
 
bool FacetEnabledHasBeenSet () const
 
void SetFacetEnabled (bool value)
 
DateOptionsWithFacetEnabled (bool value)
 
bool GetSearchEnabled () const
 
bool SearchEnabledHasBeenSet () const
 
void SetSearchEnabled (bool value)
 
DateOptionsWithSearchEnabled (bool value)
 
bool GetReturnEnabled () const
 
bool ReturnEnabledHasBeenSet () const
 
void SetReturnEnabled (bool value)
 
DateOptionsWithReturnEnabled (bool value)
 
bool GetSortEnabled () const
 
bool SortEnabledHasBeenSet () const
 
void SetSortEnabled (bool value)
 
DateOptionsWithSortEnabled (bool value)
 

Detailed Description

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

See Also:

AWS API Reference

Definition at line 34 of file DateOptions.h.

Constructor & Destructor Documentation

◆ DateOptions() [1/2]

Aws::CloudSearch::Model::DateOptions::DateOptions ( )

◆ DateOptions() [2/2]

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

Member Function Documentation

◆ DefaultValueHasBeenSet()

bool Aws::CloudSearch::Model::DateOptions::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 DateOptions.h.

◆ FacetEnabledHasBeenSet()

bool Aws::CloudSearch::Model::DateOptions::FacetEnabledHasBeenSet ( ) const
inline

Whether facet information can be returned for the field.

Definition at line 119 of file DateOptions.h.

◆ GetDefaultValue()

const Aws::String& Aws::CloudSearch::Model::DateOptions::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 DateOptions.h.

◆ GetFacetEnabled()

bool Aws::CloudSearch::Model::DateOptions::GetFacetEnabled ( ) const
inline

Whether facet information can be returned for the field.

Definition at line 114 of file DateOptions.h.

◆ GetReturnEnabled()

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

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

Definition at line 156 of file DateOptions.h.

◆ GetSearchEnabled()

bool Aws::CloudSearch::Model::DateOptions::GetSearchEnabled ( ) const
inline

Whether the contents of the field are searchable.

Definition at line 135 of file DateOptions.h.

◆ GetSortEnabled()

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

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

Definition at line 177 of file DateOptions.h.

◆ GetSourceField()

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

Definition at line 87 of file DateOptions.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ ReturnEnabledHasBeenSet()

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

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

Definition at line 161 of file DateOptions.h.

◆ SearchEnabledHasBeenSet()

bool Aws::CloudSearch::Model::DateOptions::SearchEnabledHasBeenSet ( ) const
inline

Whether the contents of the field are searchable.

Definition at line 140 of file DateOptions.h.

◆ SetDefaultValue() [1/3]

void Aws::CloudSearch::Model::DateOptions::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 DateOptions.h.

◆ SetDefaultValue() [2/3]

void Aws::CloudSearch::Model::DateOptions::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 DateOptions.h.

◆ SetDefaultValue() [3/3]

void Aws::CloudSearch::Model::DateOptions::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 DateOptions.h.

◆ SetFacetEnabled()

void Aws::CloudSearch::Model::DateOptions::SetFacetEnabled ( bool  value)
inline

Whether facet information can be returned for the field.

Definition at line 124 of file DateOptions.h.

◆ SetReturnEnabled()

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

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

Definition at line 166 of file DateOptions.h.

◆ SetSearchEnabled()

void Aws::CloudSearch::Model::DateOptions::SetSearchEnabled ( bool  value)
inline

Whether the contents of the field are searchable.

Definition at line 145 of file DateOptions.h.

◆ SetSortEnabled()

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

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

Definition at line 187 of file DateOptions.h.

◆ SetSourceField() [1/3]

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

Definition at line 93 of file DateOptions.h.

◆ SetSourceField() [2/3]

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

Definition at line 96 of file DateOptions.h.

◆ SetSourceField() [3/3]

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

Definition at line 99 of file DateOptions.h.

◆ SortEnabledHasBeenSet()

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

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

Definition at line 182 of file DateOptions.h.

◆ SourceFieldHasBeenSet()

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

Definition at line 90 of file DateOptions.h.

◆ WithDefaultValue() [1/3]

DateOptions& Aws::CloudSearch::Model::DateOptions::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 DateOptions.h.

◆ WithDefaultValue() [2/3]

DateOptions& Aws::CloudSearch::Model::DateOptions::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 DateOptions.h.

◆ WithDefaultValue() [3/3]

DateOptions& Aws::CloudSearch::Model::DateOptions::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 DateOptions.h.

◆ WithFacetEnabled()

DateOptions& Aws::CloudSearch::Model::DateOptions::WithFacetEnabled ( bool  value)
inline

Whether facet information can be returned for the field.

Definition at line 129 of file DateOptions.h.

◆ WithReturnEnabled()

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

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

Definition at line 171 of file DateOptions.h.

◆ WithSearchEnabled()

DateOptions& Aws::CloudSearch::Model::DateOptions::WithSearchEnabled ( bool  value)
inline

Whether the contents of the field are searchable.

Definition at line 150 of file DateOptions.h.

◆ WithSortEnabled()

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

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

Definition at line 192 of file DateOptions.h.

◆ WithSourceField() [1/3]

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

Definition at line 102 of file DateOptions.h.

◆ WithSourceField() [2/3]

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

Definition at line 105 of file DateOptions.h.

◆ WithSourceField() [3/3]

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

Definition at line 108 of file DateOptions.h.


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