AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::AlexaForBusiness::Model::SearchDevicesRequest Class Reference

#include <SearchDevicesRequest.h>

+ Inheritance diagram for Aws::AlexaForBusiness::Model::SearchDevicesRequest:

Public Member Functions

 SearchDevicesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
SearchDevicesRequestWithNextToken (const Aws::String &value)
 
SearchDevicesRequestWithNextToken (Aws::String &&value)
 
SearchDevicesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
SearchDevicesRequestWithMaxResults (int value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
SearchDevicesRequestWithFilters (const Aws::Vector< Filter > &value)
 
SearchDevicesRequestWithFilters (Aws::Vector< Filter > &&value)
 
SearchDevicesRequestAddFilters (const Filter &value)
 
SearchDevicesRequestAddFilters (Filter &&value)
 
const Aws::Vector< Sort > & GetSortCriteria () const
 
bool SortCriteriaHasBeenSet () const
 
void SetSortCriteria (const Aws::Vector< Sort > &value)
 
void SetSortCriteria (Aws::Vector< Sort > &&value)
 
SearchDevicesRequestWithSortCriteria (const Aws::Vector< Sort > &value)
 
SearchDevicesRequestWithSortCriteria (Aws::Vector< Sort > &&value)
 
SearchDevicesRequestAddSortCriteria (const Sort &value)
 
SearchDevicesRequestAddSortCriteria (Sort &&value)
 
- Public Member Functions inherited from Aws::AlexaForBusiness::AlexaForBusinessRequest
virtual ~AlexaForBusinessRequest ()
 
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::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
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 RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file SearchDevicesRequest.h.

Constructor & Destructor Documentation

◆ SearchDevicesRequest()

Aws::AlexaForBusiness::Model::SearchDevicesRequest::SearchDevicesRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::AddFilters ( const Filter value)
inline

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 188 of file SearchDevicesRequest.h.

◆ AddFilters() [2/2]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::AddFilters ( Filter &&  value)
inline

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 196 of file SearchDevicesRequest.h.

◆ AddSortCriteria() [1/2]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::AddSortCriteria ( const Sort value)
inline

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 253 of file SearchDevicesRequest.h.

◆ AddSortCriteria() [2/2]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::AddSortCriteria ( Sort &&  value)
inline

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 261 of file SearchDevicesRequest.h.

◆ FiltersHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchDevicesRequest::FiltersHasBeenSet ( ) const
inline

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 148 of file SearchDevicesRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::AlexaForBusiness::Model::SearchDevicesRequest::GetFilters ( ) const
inline

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 140 of file SearchDevicesRequest.h.

◆ GetMaxResults()

int Aws::AlexaForBusiness::Model::SearchDevicesRequest::GetMaxResults ( ) const
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 110 of file SearchDevicesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::AlexaForBusiness::Model::SearchDevicesRequest::GetNextToken ( ) const
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 46 of file SearchDevicesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::AlexaForBusiness::Model::SearchDevicesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::AlexaForBusiness::Model::SearchDevicesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SearchDevicesRequest.h.

◆ GetSortCriteria()

const Aws::Vector<Sort>& Aws::AlexaForBusiness::Model::SearchDevicesRequest::GetSortCriteria ( ) const
inline

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 205 of file SearchDevicesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchDevicesRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 117 of file SearchDevicesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchDevicesRequest::NextTokenHasBeenSet ( ) const
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 54 of file SearchDevicesRequest.h.

◆ SerializePayload()

Aws::String Aws::AlexaForBusiness::Model::SearchDevicesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::AlexaForBusiness::Model::SearchDevicesRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 156 of file SearchDevicesRequest.h.

◆ SetFilters() [2/2]

void Aws::AlexaForBusiness::Model::SearchDevicesRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 164 of file SearchDevicesRequest.h.

◆ SetMaxResults()

void Aws::AlexaForBusiness::Model::SearchDevicesRequest::SetMaxResults ( int  value)
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 124 of file SearchDevicesRequest.h.

◆ SetNextToken() [1/3]

void Aws::AlexaForBusiness::Model::SearchDevicesRequest::SetNextToken ( const Aws::String value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 62 of file SearchDevicesRequest.h.

◆ SetNextToken() [2/3]

void Aws::AlexaForBusiness::Model::SearchDevicesRequest::SetNextToken ( Aws::String &&  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 70 of file SearchDevicesRequest.h.

◆ SetNextToken() [3/3]

void Aws::AlexaForBusiness::Model::SearchDevicesRequest::SetNextToken ( const char *  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 78 of file SearchDevicesRequest.h.

◆ SetSortCriteria() [1/2]

void Aws::AlexaForBusiness::Model::SearchDevicesRequest::SetSortCriteria ( const Aws::Vector< Sort > &  value)
inline

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 221 of file SearchDevicesRequest.h.

◆ SetSortCriteria() [2/2]

void Aws::AlexaForBusiness::Model::SearchDevicesRequest::SetSortCriteria ( Aws::Vector< Sort > &&  value)
inline

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 229 of file SearchDevicesRequest.h.

◆ SortCriteriaHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchDevicesRequest::SortCriteriaHasBeenSet ( ) const
inline

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 213 of file SearchDevicesRequest.h.

◆ WithFilters() [1/2]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 172 of file SearchDevicesRequest.h.

◆ WithFilters() [2/2]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 180 of file SearchDevicesRequest.h.

◆ WithMaxResults()

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::WithMaxResults ( int  value)
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 131 of file SearchDevicesRequest.h.

◆ WithNextToken() [1/3]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::WithNextToken ( const Aws::String value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 86 of file SearchDevicesRequest.h.

◆ WithNextToken() [2/3]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::WithNextToken ( Aws::String &&  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 94 of file SearchDevicesRequest.h.

◆ WithNextToken() [3/3]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::WithNextToken ( const char *  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 102 of file SearchDevicesRequest.h.

◆ WithSortCriteria() [1/2]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::WithSortCriteria ( const Aws::Vector< Sort > &  value)
inline

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 237 of file SearchDevicesRequest.h.

◆ WithSortCriteria() [2/2]

SearchDevicesRequest& Aws::AlexaForBusiness::Model::SearchDevicesRequest::WithSortCriteria ( Aws::Vector< Sort > &&  value)
inline

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Definition at line 245 of file SearchDevicesRequest.h.


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