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

#include <DescribeIndexResult.h>

Public Member Functions

 DescribeIndexResult ()
 
 DescribeIndexResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeIndexResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetIndexName () const
 
void SetIndexName (const Aws::String &value)
 
void SetIndexName (Aws::String &&value)
 
void SetIndexName (const char *value)
 
DescribeIndexResultWithIndexName (const Aws::String &value)
 
DescribeIndexResultWithIndexName (Aws::String &&value)
 
DescribeIndexResultWithIndexName (const char *value)
 
const IndexStatusGetIndexStatus () const
 
void SetIndexStatus (const IndexStatus &value)
 
void SetIndexStatus (IndexStatus &&value)
 
DescribeIndexResultWithIndexStatus (const IndexStatus &value)
 
DescribeIndexResultWithIndexStatus (IndexStatus &&value)
 
const Aws::StringGetSchema () const
 
void SetSchema (const Aws::String &value)
 
void SetSchema (Aws::String &&value)
 
void SetSchema (const char *value)
 
DescribeIndexResultWithSchema (const Aws::String &value)
 
DescribeIndexResultWithSchema (Aws::String &&value)
 
DescribeIndexResultWithSchema (const char *value)
 

Detailed Description

Definition at line 28 of file DescribeIndexResult.h.

Constructor & Destructor Documentation

◆ DescribeIndexResult() [1/2]

Aws::IoT::Model::DescribeIndexResult::DescribeIndexResult ( )

◆ DescribeIndexResult() [2/2]

Aws::IoT::Model::DescribeIndexResult::DescribeIndexResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetIndexName()

const Aws::String& Aws::IoT::Model::DescribeIndexResult::GetIndexName ( ) const
inline

The index name.

Definition at line 39 of file DescribeIndexResult.h.

◆ GetIndexStatus()

const IndexStatus& Aws::IoT::Model::DescribeIndexResult::GetIndexStatus ( ) const
inline

The index status.

Definition at line 75 of file DescribeIndexResult.h.

◆ GetSchema()

const Aws::String& Aws::IoT::Model::DescribeIndexResult::GetSchema ( ) const
inline

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

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

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Definition at line 111 of file DescribeIndexResult.h.

◆ operator=()

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetIndexName() [1/3]

void Aws::IoT::Model::DescribeIndexResult::SetIndexName ( Aws::String &&  value)
inline

The index name.

Definition at line 49 of file DescribeIndexResult.h.

◆ SetIndexName() [2/3]

void Aws::IoT::Model::DescribeIndexResult::SetIndexName ( const Aws::String value)
inline

The index name.

Definition at line 44 of file DescribeIndexResult.h.

◆ SetIndexName() [3/3]

void Aws::IoT::Model::DescribeIndexResult::SetIndexName ( const char *  value)
inline

The index name.

Definition at line 54 of file DescribeIndexResult.h.

◆ SetIndexStatus() [1/2]

void Aws::IoT::Model::DescribeIndexResult::SetIndexStatus ( const IndexStatus value)
inline

The index status.

Definition at line 80 of file DescribeIndexResult.h.

◆ SetIndexStatus() [2/2]

void Aws::IoT::Model::DescribeIndexResult::SetIndexStatus ( IndexStatus &&  value)
inline

The index status.

Definition at line 85 of file DescribeIndexResult.h.

◆ SetSchema() [1/3]

void Aws::IoT::Model::DescribeIndexResult::SetSchema ( Aws::String &&  value)
inline

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

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

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Definition at line 141 of file DescribeIndexResult.h.

◆ SetSchema() [2/3]

void Aws::IoT::Model::DescribeIndexResult::SetSchema ( const Aws::String value)
inline

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

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

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Definition at line 126 of file DescribeIndexResult.h.

◆ SetSchema() [3/3]

void Aws::IoT::Model::DescribeIndexResult::SetSchema ( const char *  value)
inline

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

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

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Definition at line 156 of file DescribeIndexResult.h.

◆ WithIndexName() [1/3]

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::WithIndexName ( Aws::String &&  value)
inline

The index name.

Definition at line 64 of file DescribeIndexResult.h.

◆ WithIndexName() [2/3]

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::WithIndexName ( const Aws::String value)
inline

The index name.

Definition at line 59 of file DescribeIndexResult.h.

◆ WithIndexName() [3/3]

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::WithIndexName ( const char *  value)
inline

The index name.

Definition at line 69 of file DescribeIndexResult.h.

◆ WithIndexStatus() [1/2]

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::WithIndexStatus ( const IndexStatus value)
inline

The index status.

Definition at line 90 of file DescribeIndexResult.h.

◆ WithIndexStatus() [2/2]

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::WithIndexStatus ( IndexStatus &&  value)
inline

The index status.

Definition at line 95 of file DescribeIndexResult.h.

◆ WithSchema() [1/3]

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::WithSchema ( Aws::String &&  value)
inline

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

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

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Definition at line 186 of file DescribeIndexResult.h.

◆ WithSchema() [2/3]

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::WithSchema ( const Aws::String value)
inline

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

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

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Definition at line 171 of file DescribeIndexResult.h.

◆ WithSchema() [3/3]

DescribeIndexResult& Aws::IoT::Model::DescribeIndexResult::WithSchema ( const char *  value)
inline

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

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

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Definition at line 201 of file DescribeIndexResult.h.


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