Aws::IoT::Model::ListThingGroupsRequest Class Reference

#include <ListThingGroupsRequest.h>

Inheritance diagram for Aws::IoT::Model::ListThingGroupsRequest:

Public Member Functions
	ListThingGroupsRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
void	AddQueryStringParameters (Aws::Http::URI &uri) const override
const Aws::String &	GetNextToken () const
bool	NextTokenHasBeenSet () const
void	SetNextToken (const Aws::String &value)
void	SetNextToken (Aws::String &&value)
void	SetNextToken (const char *value)
ListThingGroupsRequest &	WithNextToken (const Aws::String &value)
ListThingGroupsRequest &	WithNextToken (Aws::String &&value)
ListThingGroupsRequest &	WithNextToken (const char *value)
int	GetMaxResults () const
bool	MaxResultsHasBeenSet () const
void	SetMaxResults (int value)
ListThingGroupsRequest &	WithMaxResults (int value)
const Aws::String &	GetParentGroup () const
bool	ParentGroupHasBeenSet () const
void	SetParentGroup (const Aws::String &value)
void	SetParentGroup (Aws::String &&value)
void	SetParentGroup (const char *value)
ListThingGroupsRequest &	WithParentGroup (const Aws::String &value)
ListThingGroupsRequest &	WithParentGroup (Aws::String &&value)
ListThingGroupsRequest &	WithParentGroup (const char *value)
const Aws::String &	GetNamePrefixFilter () const
bool	NamePrefixFilterHasBeenSet () const
void	SetNamePrefixFilter (const Aws::String &value)
void	SetNamePrefixFilter (Aws::String &&value)
void	SetNamePrefixFilter (const char *value)
ListThingGroupsRequest &	WithNamePrefixFilter (const Aws::String &value)
ListThingGroupsRequest &	WithNamePrefixFilter (Aws::String &&value)
ListThingGroupsRequest &	WithNamePrefixFilter (const char *value)
bool	GetRecursive () const
bool	RecursiveHasBeenSet () const
void	SetRecursive (bool value)
ListThingGroupsRequest &	WithRecursive (bool value)
Public Member Functions inherited from Aws::IoT::IoTRequest
virtual	~IoTRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::IoT::IoTRequest
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 25 of file ListThingGroupsRequest.h.

Constructor & Destructor Documentation

ListThingGroupsRequest()

Aws::IoT::Model::ListThingGroupsRequest::ListThingGroupsRequest

(

)

Member Function Documentation

AddQueryStringParameters()

void Aws::IoT::Model::ListThingGroupsRequest::AddQueryStringParameters ( Aws::Http::URI &  uri ) const

overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

GetMaxResults()

int Aws::IoT::Model::ListThingGroupsRequest::GetMaxResults ( ) const

inline

The maximum number of results to return at one time.

Definition at line 101 of file ListThingGroupsRequest.h.

GetNamePrefixFilter()

const Aws::String& Aws::IoT::Model::ListThingGroupsRequest::GetNamePrefixFilter ( ) const

inline

A filter that limits the results to those with the specified name prefix.

Definition at line 171 of file ListThingGroupsRequest.h.

GetNextToken()

const Aws::String& Aws::IoT::Model::ListThingGroupsRequest::GetNextToken ( ) const

inline

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Definition at line 46 of file ListThingGroupsRequest.h.

GetParentGroup()

const Aws::String& Aws::IoT::Model::ListThingGroupsRequest::GetParentGroup ( ) const

inline

A filter that limits the results to those with the specified parent group.

Definition at line 123 of file ListThingGroupsRequest.h.

GetRecursive()

bool Aws::IoT::Model::ListThingGroupsRequest::GetRecursive ( ) const

inline

If true, return child groups as well.

Definition at line 212 of file ListThingGroupsRequest.h.

GetServiceRequestName()

virtual const char* Aws::IoT::Model::ListThingGroupsRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ListThingGroupsRequest.h.

MaxResultsHasBeenSet()

bool Aws::IoT::Model::ListThingGroupsRequest::MaxResultsHasBeenSet ( ) const

inline

The maximum number of results to return at one time.

Definition at line 106 of file ListThingGroupsRequest.h.

NamePrefixFilterHasBeenSet()

bool Aws::IoT::Model::ListThingGroupsRequest::NamePrefixFilterHasBeenSet ( ) const

inline

A filter that limits the results to those with the specified name prefix.

Definition at line 176 of file ListThingGroupsRequest.h.

NextTokenHasBeenSet()

bool Aws::IoT::Model::ListThingGroupsRequest::NextTokenHasBeenSet ( ) const

inline

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Definition at line 53 of file ListThingGroupsRequest.h.

ParentGroupHasBeenSet()

bool Aws::IoT::Model::ListThingGroupsRequest::ParentGroupHasBeenSet ( ) const

inline

A filter that limits the results to those with the specified parent group.

Definition at line 129 of file ListThingGroupsRequest.h.

RecursiveHasBeenSet()

bool Aws::IoT::Model::ListThingGroupsRequest::RecursiveHasBeenSet ( ) const

inline

If true, return child groups as well.

Definition at line 217 of file ListThingGroupsRequest.h.

SerializePayload()

Aws::String Aws::IoT::Model::ListThingGroupsRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetMaxResults()

void Aws::IoT::Model::ListThingGroupsRequest::SetMaxResults ( int  value )

inline

The maximum number of results to return at one time.

Definition at line 111 of file ListThingGroupsRequest.h.

SetNamePrefixFilter() [1/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetNamePrefixFilter ( Aws::String &&  value )

inline

A filter that limits the results to those with the specified name prefix.

Definition at line 186 of file ListThingGroupsRequest.h.

SetNamePrefixFilter() [2/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetNamePrefixFilter ( const Aws::String &  value )

inline

A filter that limits the results to those with the specified name prefix.

Definition at line 181 of file ListThingGroupsRequest.h.

SetNamePrefixFilter() [3/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetNamePrefixFilter ( const char *  value )

inline

A filter that limits the results to those with the specified name prefix.

Definition at line 191 of file ListThingGroupsRequest.h.

SetNextToken() [1/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetNextToken ( Aws::String &&  value )

inline

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Definition at line 67 of file ListThingGroupsRequest.h.

SetNextToken() [2/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetNextToken ( const Aws::String &  value )

inline

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Definition at line 60 of file ListThingGroupsRequest.h.

SetNextToken() [3/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetNextToken ( const char *  value )

inline

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Definition at line 74 of file ListThingGroupsRequest.h.

SetParentGroup() [1/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetParentGroup ( Aws::String &&  value )

inline

A filter that limits the results to those with the specified parent group.

Definition at line 141 of file ListThingGroupsRequest.h.

SetParentGroup() [2/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetParentGroup ( const Aws::String &  value )

inline

A filter that limits the results to those with the specified parent group.

Definition at line 135 of file ListThingGroupsRequest.h.

SetParentGroup() [3/3]

void Aws::IoT::Model::ListThingGroupsRequest::SetParentGroup ( const char *  value )

inline

A filter that limits the results to those with the specified parent group.

Definition at line 147 of file ListThingGroupsRequest.h.

SetRecursive()

void Aws::IoT::Model::ListThingGroupsRequest::SetRecursive ( bool  value )

inline

If true, return child groups as well.

Definition at line 222 of file ListThingGroupsRequest.h.

WithMaxResults()

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithMaxResults ( int  value )

inline

The maximum number of results to return at one time.

Definition at line 116 of file ListThingGroupsRequest.h.

WithNamePrefixFilter() [1/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithNamePrefixFilter ( Aws::String &&  value )

inline

A filter that limits the results to those with the specified name prefix.

Definition at line 201 of file ListThingGroupsRequest.h.

WithNamePrefixFilter() [2/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithNamePrefixFilter ( const Aws::String &  value )

inline

A filter that limits the results to those with the specified name prefix.

Definition at line 196 of file ListThingGroupsRequest.h.

WithNamePrefixFilter() [3/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithNamePrefixFilter ( const char *  value )

inline

A filter that limits the results to those with the specified name prefix.

Definition at line 206 of file ListThingGroupsRequest.h.

WithNextToken() [1/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithNextToken ( Aws::String &&  value )

inline

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Definition at line 88 of file ListThingGroupsRequest.h.

WithNextToken() [2/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithNextToken ( const Aws::String &  value )

inline

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Definition at line 81 of file ListThingGroupsRequest.h.

WithNextToken() [3/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithNextToken ( const char *  value )

inline

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Definition at line 95 of file ListThingGroupsRequest.h.

WithParentGroup() [1/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithParentGroup ( Aws::String &&  value )

inline

A filter that limits the results to those with the specified parent group.

Definition at line 159 of file ListThingGroupsRequest.h.

WithParentGroup() [2/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithParentGroup ( const Aws::String &  value )

inline

A filter that limits the results to those with the specified parent group.

Definition at line 153 of file ListThingGroupsRequest.h.

WithParentGroup() [3/3]

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithParentGroup ( const char *  value )

inline

A filter that limits the results to those with the specified parent group.

Definition at line 165 of file ListThingGroupsRequest.h.

WithRecursive()

ListThingGroupsRequest& Aws::IoT::Model::ListThingGroupsRequest::WithRecursive ( bool  value )

inline

If true, return child groups as well.

Definition at line 227 of file ListThingGroupsRequest.h.

---

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

• aws-cpp-sdk-iot/include/aws/iot/model/ListThingGroupsRequest.h