AWS SDK for C++  1.8.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::DAX::Model::DescribeEventsRequest Class Reference

#include <DescribeEventsRequest.h>

+ Inheritance diagram for Aws::DAX::Model::DescribeEventsRequest:

Public Member Functions

 DescribeEventsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetSourceName () const
 
bool SourceNameHasBeenSet () const
 
void SetSourceName (const Aws::String &value)
 
void SetSourceName (Aws::String &&value)
 
void SetSourceName (const char *value)
 
DescribeEventsRequestWithSourceName (const Aws::String &value)
 
DescribeEventsRequestWithSourceName (Aws::String &&value)
 
DescribeEventsRequestWithSourceName (const char *value)
 
const SourceTypeGetSourceType () const
 
bool SourceTypeHasBeenSet () const
 
void SetSourceType (const SourceType &value)
 
void SetSourceType (SourceType &&value)
 
DescribeEventsRequestWithSourceType (const SourceType &value)
 
DescribeEventsRequestWithSourceType (SourceType &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
DescribeEventsRequestWithStartTime (const Aws::Utils::DateTime &value)
 
DescribeEventsRequestWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
DescribeEventsRequestWithEndTime (const Aws::Utils::DateTime &value)
 
DescribeEventsRequestWithEndTime (Aws::Utils::DateTime &&value)
 
int GetDuration () const
 
bool DurationHasBeenSet () const
 
void SetDuration (int value)
 
DescribeEventsRequestWithDuration (int value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeEventsRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeEventsRequestWithNextToken (const Aws::String &value)
 
DescribeEventsRequestWithNextToken (Aws::String &&value)
 
DescribeEventsRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::DAX::DAXRequest
virtual ~DAXRequest ()
 
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 23 of file DescribeEventsRequest.h.

Constructor & Destructor Documentation

◆ DescribeEventsRequest()

Aws::DAX::Model::DescribeEventsRequest::DescribeEventsRequest ( )

Member Function Documentation

◆ DurationHasBeenSet()

bool Aws::DAX::Model::DescribeEventsRequest::DurationHasBeenSet ( ) const
inline

The number of minutes' worth of events to retrieve.

Definition at line 207 of file DescribeEventsRequest.h.

◆ EndTimeHasBeenSet()

bool Aws::DAX::Model::DescribeEventsRequest::EndTimeHasBeenSet ( ) const
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Definition at line 172 of file DescribeEventsRequest.h.

◆ GetDuration()

int Aws::DAX::Model::DescribeEventsRequest::GetDuration ( ) const
inline

The number of minutes' worth of events to retrieve.

Definition at line 202 of file DescribeEventsRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::DAX::Model::DescribeEventsRequest::GetEndTime ( ) const
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Definition at line 166 of file DescribeEventsRequest.h.

◆ GetMaxResults()

int Aws::DAX::Model::DescribeEventsRequest::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.

The value for MaxResults must be between 20 and 100.

Definition at line 226 of file DescribeEventsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::DAX::Model::DescribeEventsRequest::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 259 of file DescribeEventsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DAX::Model::DescribeEventsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::DAX::DAXRequest.

◆ GetServiceRequestName()

virtual const char* Aws::DAX::Model::DescribeEventsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeEventsRequest.h.

◆ GetSourceName()

const Aws::String& Aws::DAX::Model::DescribeEventsRequest::GetSourceName ( ) const
inline

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Definition at line 43 of file DescribeEventsRequest.h.

◆ GetSourceType()

const SourceType& Aws::DAX::Model::DescribeEventsRequest::GetSourceType ( ) const
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 92 of file DescribeEventsRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::DAX::Model::DescribeEventsRequest::GetStartTime ( ) const
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Definition at line 129 of file DescribeEventsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::DAX::Model::DescribeEventsRequest::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.

The value for MaxResults must be between 20 and 100.

Definition at line 234 of file DescribeEventsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::DAX::Model::DescribeEventsRequest::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 267 of file DescribeEventsRequest.h.

◆ SerializePayload()

Aws::String Aws::DAX::Model::DescribeEventsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDuration()

void Aws::DAX::Model::DescribeEventsRequest::SetDuration ( int  value)
inline

The number of minutes' worth of events to retrieve.

Definition at line 212 of file DescribeEventsRequest.h.

◆ SetEndTime() [1/2]

void Aws::DAX::Model::DescribeEventsRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Definition at line 178 of file DescribeEventsRequest.h.

◆ SetEndTime() [2/2]

void Aws::DAX::Model::DescribeEventsRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Definition at line 184 of file DescribeEventsRequest.h.

◆ SetMaxResults()

void Aws::DAX::Model::DescribeEventsRequest::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.

The value for MaxResults must be between 20 and 100.

Definition at line 242 of file DescribeEventsRequest.h.

◆ SetNextToken() [1/3]

void Aws::DAX::Model::DescribeEventsRequest::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 275 of file DescribeEventsRequest.h.

◆ SetNextToken() [2/3]

void Aws::DAX::Model::DescribeEventsRequest::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 283 of file DescribeEventsRequest.h.

◆ SetNextToken() [3/3]

void Aws::DAX::Model::DescribeEventsRequest::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 291 of file DescribeEventsRequest.h.

◆ SetSourceName() [1/3]

void Aws::DAX::Model::DescribeEventsRequest::SetSourceName ( const Aws::String value)
inline

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Definition at line 55 of file DescribeEventsRequest.h.

◆ SetSourceName() [2/3]

void Aws::DAX::Model::DescribeEventsRequest::SetSourceName ( Aws::String &&  value)
inline

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Definition at line 61 of file DescribeEventsRequest.h.

◆ SetSourceName() [3/3]

void Aws::DAX::Model::DescribeEventsRequest::SetSourceName ( const char *  value)
inline

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Definition at line 67 of file DescribeEventsRequest.h.

◆ SetSourceType() [1/2]

void Aws::DAX::Model::DescribeEventsRequest::SetSourceType ( const SourceType value)
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 104 of file DescribeEventsRequest.h.

◆ SetSourceType() [2/2]

void Aws::DAX::Model::DescribeEventsRequest::SetSourceType ( SourceType &&  value)
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 110 of file DescribeEventsRequest.h.

◆ SetStartTime() [1/2]

void Aws::DAX::Model::DescribeEventsRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Definition at line 141 of file DescribeEventsRequest.h.

◆ SetStartTime() [2/2]

void Aws::DAX::Model::DescribeEventsRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Definition at line 147 of file DescribeEventsRequest.h.

◆ SourceNameHasBeenSet()

bool Aws::DAX::Model::DescribeEventsRequest::SourceNameHasBeenSet ( ) const
inline

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Definition at line 49 of file DescribeEventsRequest.h.

◆ SourceTypeHasBeenSet()

bool Aws::DAX::Model::DescribeEventsRequest::SourceTypeHasBeenSet ( ) const
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 98 of file DescribeEventsRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::DAX::Model::DescribeEventsRequest::StartTimeHasBeenSet ( ) const
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Definition at line 135 of file DescribeEventsRequest.h.

◆ WithDuration()

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithDuration ( int  value)
inline

The number of minutes' worth of events to retrieve.

Definition at line 217 of file DescribeEventsRequest.h.

◆ WithEndTime() [1/2]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Definition at line 190 of file DescribeEventsRequest.h.

◆ WithEndTime() [2/2]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Definition at line 196 of file DescribeEventsRequest.h.

◆ WithMaxResults()

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::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.

The value for MaxResults must be between 20 and 100.

Definition at line 250 of file DescribeEventsRequest.h.

◆ WithNextToken() [1/3]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::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 299 of file DescribeEventsRequest.h.

◆ WithNextToken() [2/3]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::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 307 of file DescribeEventsRequest.h.

◆ WithNextToken() [3/3]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::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 315 of file DescribeEventsRequest.h.

◆ WithSourceName() [1/3]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithSourceName ( const Aws::String value)
inline

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Definition at line 73 of file DescribeEventsRequest.h.

◆ WithSourceName() [2/3]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithSourceName ( Aws::String &&  value)
inline

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Definition at line 79 of file DescribeEventsRequest.h.

◆ WithSourceName() [3/3]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithSourceName ( const char *  value)
inline

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Definition at line 85 of file DescribeEventsRequest.h.

◆ WithSourceType() [1/2]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithSourceType ( const SourceType value)
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 116 of file DescribeEventsRequest.h.

◆ WithSourceType() [2/2]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithSourceType ( SourceType &&  value)
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 122 of file DescribeEventsRequest.h.

◆ WithStartTime() [1/2]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Definition at line 153 of file DescribeEventsRequest.h.

◆ WithStartTime() [2/2]

DescribeEventsRequest& Aws::DAX::Model::DescribeEventsRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Definition at line 159 of file DescribeEventsRequest.h.


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