AWS SDK for C++  1.9.45
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::ThingIndexingConfiguration Class Reference

#include <ThingIndexingConfiguration.h>

Public Member Functions

 ThingIndexingConfiguration ()
 
 ThingIndexingConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
ThingIndexingConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ThingIndexingModeGetThingIndexingMode () const
 
bool ThingIndexingModeHasBeenSet () const
 
void SetThingIndexingMode (const ThingIndexingMode &value)
 
void SetThingIndexingMode (ThingIndexingMode &&value)
 
ThingIndexingConfigurationWithThingIndexingMode (const ThingIndexingMode &value)
 
ThingIndexingConfigurationWithThingIndexingMode (ThingIndexingMode &&value)
 
const ThingConnectivityIndexingModeGetThingConnectivityIndexingMode () const
 
bool ThingConnectivityIndexingModeHasBeenSet () const
 
void SetThingConnectivityIndexingMode (const ThingConnectivityIndexingMode &value)
 
void SetThingConnectivityIndexingMode (ThingConnectivityIndexingMode &&value)
 
ThingIndexingConfigurationWithThingConnectivityIndexingMode (const ThingConnectivityIndexingMode &value)
 
ThingIndexingConfigurationWithThingConnectivityIndexingMode (ThingConnectivityIndexingMode &&value)
 
const Aws::Vector< Field > & GetManagedFields () const
 
bool ManagedFieldsHasBeenSet () const
 
void SetManagedFields (const Aws::Vector< Field > &value)
 
void SetManagedFields (Aws::Vector< Field > &&value)
 
ThingIndexingConfigurationWithManagedFields (const Aws::Vector< Field > &value)
 
ThingIndexingConfigurationWithManagedFields (Aws::Vector< Field > &&value)
 
ThingIndexingConfigurationAddManagedFields (const Field &value)
 
ThingIndexingConfigurationAddManagedFields (Field &&value)
 
const Aws::Vector< Field > & GetCustomFields () const
 
bool CustomFieldsHasBeenSet () const
 
void SetCustomFields (const Aws::Vector< Field > &value)
 
void SetCustomFields (Aws::Vector< Field > &&value)
 
ThingIndexingConfigurationWithCustomFields (const Aws::Vector< Field > &value)
 
ThingIndexingConfigurationWithCustomFields (Aws::Vector< Field > &&value)
 
ThingIndexingConfigurationAddCustomFields (const Field &value)
 
ThingIndexingConfigurationAddCustomFields (Field &&value)
 

Detailed Description

The thing indexing configuration. For more information, see Managing Thing Indexing.

See Also:

AWS API Reference

Definition at line 36 of file ThingIndexingConfiguration.h.

Constructor & Destructor Documentation

◆ ThingIndexingConfiguration() [1/2]

Aws::IoT::Model::ThingIndexingConfiguration::ThingIndexingConfiguration ( )

◆ ThingIndexingConfiguration() [2/2]

Aws::IoT::Model::ThingIndexingConfiguration::ThingIndexingConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddCustomFields() [1/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::AddCustomFields ( const Field value)
inline

Contains custom field names and their data type.

Definition at line 225 of file ThingIndexingConfiguration.h.

◆ AddCustomFields() [2/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::AddCustomFields ( Field &&  value)
inline

Contains custom field names and their data type.

Definition at line 230 of file ThingIndexingConfiguration.h.

◆ AddManagedFields() [1/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::AddManagedFields ( const Field value)
inline

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

Definition at line 183 of file ThingIndexingConfiguration.h.

◆ AddManagedFields() [2/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::AddManagedFields ( Field &&  value)
inline

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

Definition at line 189 of file ThingIndexingConfiguration.h.

◆ CustomFieldsHasBeenSet()

bool Aws::IoT::Model::ThingIndexingConfiguration::CustomFieldsHasBeenSet ( ) const
inline

Contains custom field names and their data type.

Definition at line 200 of file ThingIndexingConfiguration.h.

◆ GetCustomFields()

const Aws::Vector<Field>& Aws::IoT::Model::ThingIndexingConfiguration::GetCustomFields ( ) const
inline

Contains custom field names and their data type.

Definition at line 195 of file ThingIndexingConfiguration.h.

◆ GetManagedFields()

const Aws::Vector<Field>& Aws::IoT::Model::ThingIndexingConfiguration::GetManagedFields ( ) const
inline

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

Definition at line 147 of file ThingIndexingConfiguration.h.

◆ GetThingConnectivityIndexingMode()

const ThingConnectivityIndexingMode& Aws::IoT::Model::ThingIndexingConfiguration::GetThingConnectivityIndexingMode ( ) const
inline

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

  • OFF - Thing connectivity status indexing is disabled.

Definition at line 100 of file ThingIndexingConfiguration.h.

◆ GetThingIndexingMode()

const ThingIndexingMode& Aws::IoT::Model::ThingIndexingConfiguration::GetThingIndexingMode ( ) const
inline

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.

  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

  • OFF - Thing indexing is disabled.

Definition at line 51 of file ThingIndexingConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::ThingIndexingConfiguration::Jsonize ( ) const

◆ ManagedFieldsHasBeenSet()

bool Aws::IoT::Model::ThingIndexingConfiguration::ManagedFieldsHasBeenSet ( ) const
inline

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

Definition at line 153 of file ThingIndexingConfiguration.h.

◆ operator=()

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCustomFields() [1/2]

void Aws::IoT::Model::ThingIndexingConfiguration::SetCustomFields ( Aws::Vector< Field > &&  value)
inline

Contains custom field names and their data type.

Definition at line 210 of file ThingIndexingConfiguration.h.

◆ SetCustomFields() [2/2]

void Aws::IoT::Model::ThingIndexingConfiguration::SetCustomFields ( const Aws::Vector< Field > &  value)
inline

Contains custom field names and their data type.

Definition at line 205 of file ThingIndexingConfiguration.h.

◆ SetManagedFields() [1/2]

void Aws::IoT::Model::ThingIndexingConfiguration::SetManagedFields ( Aws::Vector< Field > &&  value)
inline

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

Definition at line 165 of file ThingIndexingConfiguration.h.

◆ SetManagedFields() [2/2]

void Aws::IoT::Model::ThingIndexingConfiguration::SetManagedFields ( const Aws::Vector< Field > &  value)
inline

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

Definition at line 159 of file ThingIndexingConfiguration.h.

◆ SetThingConnectivityIndexingMode() [1/2]

void Aws::IoT::Model::ThingIndexingConfiguration::SetThingConnectivityIndexingMode ( const ThingConnectivityIndexingMode value)
inline

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

  • OFF - Thing connectivity status indexing is disabled.

Definition at line 116 of file ThingIndexingConfiguration.h.

◆ SetThingConnectivityIndexingMode() [2/2]

void Aws::IoT::Model::ThingIndexingConfiguration::SetThingConnectivityIndexingMode ( ThingConnectivityIndexingMode &&  value)
inline

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

  • OFF - Thing connectivity status indexing is disabled.

Definition at line 124 of file ThingIndexingConfiguration.h.

◆ SetThingIndexingMode() [1/2]

void Aws::IoT::Model::ThingIndexingConfiguration::SetThingIndexingMode ( const ThingIndexingMode value)
inline

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.

  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

  • OFF - Thing indexing is disabled.

Definition at line 67 of file ThingIndexingConfiguration.h.

◆ SetThingIndexingMode() [2/2]

void Aws::IoT::Model::ThingIndexingConfiguration::SetThingIndexingMode ( ThingIndexingMode &&  value)
inline

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.

  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

  • OFF - Thing indexing is disabled.

Definition at line 75 of file ThingIndexingConfiguration.h.

◆ ThingConnectivityIndexingModeHasBeenSet()

bool Aws::IoT::Model::ThingIndexingConfiguration::ThingConnectivityIndexingModeHasBeenSet ( ) const
inline

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

  • OFF - Thing connectivity status indexing is disabled.

Definition at line 108 of file ThingIndexingConfiguration.h.

◆ ThingIndexingModeHasBeenSet()

bool Aws::IoT::Model::ThingIndexingConfiguration::ThingIndexingModeHasBeenSet ( ) const
inline

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.

  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

  • OFF - Thing indexing is disabled.

Definition at line 59 of file ThingIndexingConfiguration.h.

◆ WithCustomFields() [1/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::WithCustomFields ( Aws::Vector< Field > &&  value)
inline

Contains custom field names and their data type.

Definition at line 220 of file ThingIndexingConfiguration.h.

◆ WithCustomFields() [2/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::WithCustomFields ( const Aws::Vector< Field > &  value)
inline

Contains custom field names and their data type.

Definition at line 215 of file ThingIndexingConfiguration.h.

◆ WithManagedFields() [1/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::WithManagedFields ( Aws::Vector< Field > &&  value)
inline

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

Definition at line 177 of file ThingIndexingConfiguration.h.

◆ WithManagedFields() [2/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::WithManagedFields ( const Aws::Vector< Field > &  value)
inline

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

Definition at line 171 of file ThingIndexingConfiguration.h.

◆ WithThingConnectivityIndexingMode() [1/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::WithThingConnectivityIndexingMode ( const ThingConnectivityIndexingMode value)
inline

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

  • OFF - Thing connectivity status indexing is disabled.

Definition at line 132 of file ThingIndexingConfiguration.h.

◆ WithThingConnectivityIndexingMode() [2/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::WithThingConnectivityIndexingMode ( ThingConnectivityIndexingMode &&  value)
inline

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

  • OFF - Thing connectivity status indexing is disabled.

Definition at line 140 of file ThingIndexingConfiguration.h.

◆ WithThingIndexingMode() [1/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::WithThingIndexingMode ( const ThingIndexingMode value)
inline

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.

  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

  • OFF - Thing indexing is disabled.

Definition at line 83 of file ThingIndexingConfiguration.h.

◆ WithThingIndexingMode() [2/2]

ThingIndexingConfiguration& Aws::IoT::Model::ThingIndexingConfiguration::WithThingIndexingMode ( ThingIndexingMode &&  value)
inline

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.

  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

  • OFF - Thing indexing is disabled.

Definition at line 91 of file ThingIndexingConfiguration.h.


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