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

#include <ListDeviceEventsRequest.h>

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

Public Member Functions

 ListDeviceEventsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDeviceArn () const
 
bool DeviceArnHasBeenSet () const
 
void SetDeviceArn (const Aws::String &value)
 
void SetDeviceArn (Aws::String &&value)
 
void SetDeviceArn (const char *value)
 
ListDeviceEventsRequestWithDeviceArn (const Aws::String &value)
 
ListDeviceEventsRequestWithDeviceArn (Aws::String &&value)
 
ListDeviceEventsRequestWithDeviceArn (const char *value)
 
const DeviceEventTypeGetEventType () const
 
bool EventTypeHasBeenSet () const
 
void SetEventType (const DeviceEventType &value)
 
void SetEventType (DeviceEventType &&value)
 
ListDeviceEventsRequestWithEventType (const DeviceEventType &value)
 
ListDeviceEventsRequestWithEventType (DeviceEventType &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListDeviceEventsRequestWithNextToken (const Aws::String &value)
 
ListDeviceEventsRequestWithNextToken (Aws::String &&value)
 
ListDeviceEventsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListDeviceEventsRequestWithMaxResults (int 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 22 of file ListDeviceEventsRequest.h.

Constructor & Destructor Documentation

◆ ListDeviceEventsRequest()

Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::ListDeviceEventsRequest ( )

Member Function Documentation

◆ DeviceArnHasBeenSet()

bool Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::DeviceArnHasBeenSet ( ) const
inline

The ARN of a device.

Definition at line 46 of file ListDeviceEventsRequest.h.

◆ EventTypeHasBeenSet()

bool Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::EventTypeHasBeenSet ( ) const
inline

The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

Definition at line 93 of file ListDeviceEventsRequest.h.

◆ GetDeviceArn()

const Aws::String& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::GetDeviceArn ( ) const
inline

The ARN of a device.

Definition at line 41 of file ListDeviceEventsRequest.h.

◆ GetEventType()

const DeviceEventType& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::GetEventType ( ) const
inline

The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

Definition at line 85 of file ListDeviceEventsRequest.h.

◆ GetMaxResults()

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

The maximum number of results to include in the response. The default value is 50. 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 206 of file ListDeviceEventsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

Definition at line 135 of file ListDeviceEventsRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListDeviceEventsRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of results to include in the response. The default value is 50. 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 213 of file ListDeviceEventsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

Definition at line 144 of file ListDeviceEventsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDeviceArn() [1/3]

void Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::SetDeviceArn ( const Aws::String value)
inline

The ARN of a device.

Definition at line 51 of file ListDeviceEventsRequest.h.

◆ SetDeviceArn() [2/3]

void Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::SetDeviceArn ( Aws::String &&  value)
inline

The ARN of a device.

Definition at line 56 of file ListDeviceEventsRequest.h.

◆ SetDeviceArn() [3/3]

void Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::SetDeviceArn ( const char *  value)
inline

The ARN of a device.

Definition at line 61 of file ListDeviceEventsRequest.h.

◆ SetEventType() [1/2]

void Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::SetEventType ( const DeviceEventType value)
inline

The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

Definition at line 101 of file ListDeviceEventsRequest.h.

◆ SetEventType() [2/2]

void Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::SetEventType ( DeviceEventType &&  value)
inline

The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

Definition at line 109 of file ListDeviceEventsRequest.h.

◆ SetMaxResults()

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

The maximum number of results to include in the response. The default value is 50. 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 220 of file ListDeviceEventsRequest.h.

◆ SetNextToken() [1/3]

void Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

Definition at line 153 of file ListDeviceEventsRequest.h.

◆ SetNextToken() [2/3]

void Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

Definition at line 162 of file ListDeviceEventsRequest.h.

◆ SetNextToken() [3/3]

void Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

Definition at line 171 of file ListDeviceEventsRequest.h.

◆ WithDeviceArn() [1/3]

ListDeviceEventsRequest& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::WithDeviceArn ( const Aws::String value)
inline

The ARN of a device.

Definition at line 66 of file ListDeviceEventsRequest.h.

◆ WithDeviceArn() [2/3]

ListDeviceEventsRequest& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::WithDeviceArn ( Aws::String &&  value)
inline

The ARN of a device.

Definition at line 71 of file ListDeviceEventsRequest.h.

◆ WithDeviceArn() [3/3]

ListDeviceEventsRequest& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::WithDeviceArn ( const char *  value)
inline

The ARN of a device.

Definition at line 76 of file ListDeviceEventsRequest.h.

◆ WithEventType() [1/2]

ListDeviceEventsRequest& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::WithEventType ( const DeviceEventType value)
inline

The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

Definition at line 117 of file ListDeviceEventsRequest.h.

◆ WithEventType() [2/2]

ListDeviceEventsRequest& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::WithEventType ( DeviceEventType &&  value)
inline

The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

Definition at line 125 of file ListDeviceEventsRequest.h.

◆ WithMaxResults()

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

The maximum number of results to include in the response. The default value is 50. 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 227 of file ListDeviceEventsRequest.h.

◆ WithNextToken() [1/3]

ListDeviceEventsRequest& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

Definition at line 180 of file ListDeviceEventsRequest.h.

◆ WithNextToken() [2/3]

ListDeviceEventsRequest& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

Definition at line 189 of file ListDeviceEventsRequest.h.

◆ WithNextToken() [3/3]

ListDeviceEventsRequest& Aws::AlexaForBusiness::Model::ListDeviceEventsRequest::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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

Definition at line 198 of file ListDeviceEventsRequest.h.


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