AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::ElastiCache::Model::DescribeEventsRequest Class Reference

#include <DescribeEventsRequest.h>

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

Public Member Functions

 DescribeEventsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetSourceIdentifier () const
 
bool SourceIdentifierHasBeenSet () const
 
void SetSourceIdentifier (const Aws::String &value)
 
void SetSourceIdentifier (Aws::String &&value)
 
void SetSourceIdentifier (const char *value)
 
DescribeEventsRequestWithSourceIdentifier (const Aws::String &value)
 
DescribeEventsRequestWithSourceIdentifier (Aws::String &&value)
 
DescribeEventsRequestWithSourceIdentifier (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 GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeEventsRequestWithMaxRecords (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeEventsRequestWithMarker (const Aws::String &value)
 
DescribeEventsRequestWithMarker (Aws::String &&value)
 
DescribeEventsRequestWithMarker (const char *value)
 
- Public Member Functions inherited from Aws::ElastiCache::ElastiCacheRequest
virtual ~ElastiCacheRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::ElastiCache::ElastiCacheRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input of a DescribeEvents operation.

See Also:

AWS API Reference

Definition at line 27 of file DescribeEventsRequest.h.

Constructor & Destructor Documentation

◆ DescribeEventsRequest()

Aws::ElastiCache::Model::DescribeEventsRequest::DescribeEventsRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::ElastiCache::Model::DescribeEventsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ DurationHasBeenSet()

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

The number of minutes worth of events to retrieve.

Definition at line 213 of file DescribeEventsRequest.h.

◆ EndTimeHasBeenSet()

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 178 of file DescribeEventsRequest.h.

◆ GetDuration()

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

The number of minutes worth of events to retrieve.

Definition at line 208 of file DescribeEventsRequest.h.

◆ GetEndTime()

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 172 of file DescribeEventsRequest.h.

◆ GetMarker()

const Aws::String& Aws::ElastiCache::Model::DescribeEventsRequest::GetMarker ( ) const
inline

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

Definition at line 265 of file DescribeEventsRequest.h.

◆ GetMaxRecords()

int Aws::ElastiCache::Model::DescribeEventsRequest::GetMaxRecords ( ) const
inline

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

Default: 100

Constraints: minimum 20; maximum 100.

Definition at line 232 of file DescribeEventsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DescribeEventsRequest.h.

◆ GetSourceIdentifier()

const Aws::String& Aws::ElastiCache::Model::DescribeEventsRequest::GetSourceIdentifier ( ) const
inline

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

Definition at line 49 of file DescribeEventsRequest.h.

◆ GetSourceType()

const SourceType& Aws::ElastiCache::Model::DescribeEventsRequest::GetSourceType ( ) 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.

◆ GetStartTime()

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 135 of file DescribeEventsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::ElastiCache::Model::DescribeEventsRequest::MarkerHasBeenSet ( ) const
inline

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

Definition at line 273 of file DescribeEventsRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::ElastiCache::Model::DescribeEventsRequest::MaxRecordsHasBeenSet ( ) const
inline

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

Default: 100

Constraints: minimum 20; maximum 100.

Definition at line 240 of file DescribeEventsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDuration()

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

The number of minutes worth of events to retrieve.

Definition at line 218 of file DescribeEventsRequest.h.

◆ SetEndTime() [1/2]

void Aws::ElastiCache::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.

Example: 2017-03-30T07:03:49.555Z

Definition at line 184 of file DescribeEventsRequest.h.

◆ SetEndTime() [2/2]

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 190 of file DescribeEventsRequest.h.

◆ SetMarker() [1/3]

void Aws::ElastiCache::Model::DescribeEventsRequest::SetMarker ( const Aws::String value)
inline

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

Definition at line 281 of file DescribeEventsRequest.h.

◆ SetMarker() [2/3]

void Aws::ElastiCache::Model::DescribeEventsRequest::SetMarker ( Aws::String &&  value)
inline

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

Definition at line 289 of file DescribeEventsRequest.h.

◆ SetMarker() [3/3]

void Aws::ElastiCache::Model::DescribeEventsRequest::SetMarker ( const char *  value)
inline

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

Definition at line 297 of file DescribeEventsRequest.h.

◆ SetMaxRecords()

void Aws::ElastiCache::Model::DescribeEventsRequest::SetMaxRecords ( int  value)
inline

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

Default: 100

Constraints: minimum 20; maximum 100.

Definition at line 248 of file DescribeEventsRequest.h.

◆ SetSourceIdentifier() [1/3]

void Aws::ElastiCache::Model::DescribeEventsRequest::SetSourceIdentifier ( const Aws::String value)
inline

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

Definition at line 61 of file DescribeEventsRequest.h.

◆ SetSourceIdentifier() [2/3]

void Aws::ElastiCache::Model::DescribeEventsRequest::SetSourceIdentifier ( Aws::String &&  value)
inline

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

Definition at line 67 of file DescribeEventsRequest.h.

◆ SetSourceIdentifier() [3/3]

void Aws::ElastiCache::Model::DescribeEventsRequest::SetSourceIdentifier ( const char *  value)
inline

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

Definition at line 73 of file DescribeEventsRequest.h.

◆ SetSourceType() [1/2]

void Aws::ElastiCache::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 110 of file DescribeEventsRequest.h.

◆ SetSourceType() [2/2]

void Aws::ElastiCache::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 116 of file DescribeEventsRequest.h.

◆ SetStartTime() [1/2]

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 147 of file DescribeEventsRequest.h.

◆ SetStartTime() [2/2]

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 153 of file DescribeEventsRequest.h.

◆ SourceIdentifierHasBeenSet()

bool Aws::ElastiCache::Model::DescribeEventsRequest::SourceIdentifierHasBeenSet ( ) const
inline

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

Definition at line 55 of file DescribeEventsRequest.h.

◆ SourceTypeHasBeenSet()

bool Aws::ElastiCache::Model::DescribeEventsRequest::SourceTypeHasBeenSet ( ) const
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.

◆ StartTimeHasBeenSet()

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 141 of file DescribeEventsRequest.h.

◆ WithDuration()

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

The number of minutes worth of events to retrieve.

Definition at line 223 of file DescribeEventsRequest.h.

◆ WithEndTime() [1/2]

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 196 of file DescribeEventsRequest.h.

◆ WithEndTime() [2/2]

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 202 of file DescribeEventsRequest.h.

◆ WithMarker() [1/3]

DescribeEventsRequest& Aws::ElastiCache::Model::DescribeEventsRequest::WithMarker ( const Aws::String value)
inline

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

Definition at line 305 of file DescribeEventsRequest.h.

◆ WithMarker() [2/3]

DescribeEventsRequest& Aws::ElastiCache::Model::DescribeEventsRequest::WithMarker ( Aws::String &&  value)
inline

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

Definition at line 313 of file DescribeEventsRequest.h.

◆ WithMarker() [3/3]

DescribeEventsRequest& Aws::ElastiCache::Model::DescribeEventsRequest::WithMarker ( const char *  value)
inline

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

Definition at line 321 of file DescribeEventsRequest.h.

◆ WithMaxRecords()

DescribeEventsRequest& Aws::ElastiCache::Model::DescribeEventsRequest::WithMaxRecords ( int  value)
inline

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

Default: 100

Constraints: minimum 20; maximum 100.

Definition at line 256 of file DescribeEventsRequest.h.

◆ WithSourceIdentifier() [1/3]

DescribeEventsRequest& Aws::ElastiCache::Model::DescribeEventsRequest::WithSourceIdentifier ( const Aws::String value)
inline

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

Definition at line 79 of file DescribeEventsRequest.h.

◆ WithSourceIdentifier() [2/3]

DescribeEventsRequest& Aws::ElastiCache::Model::DescribeEventsRequest::WithSourceIdentifier ( Aws::String &&  value)
inline

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

Definition at line 85 of file DescribeEventsRequest.h.

◆ WithSourceIdentifier() [3/3]

DescribeEventsRequest& Aws::ElastiCache::Model::DescribeEventsRequest::WithSourceIdentifier ( const char *  value)
inline

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

Definition at line 91 of file DescribeEventsRequest.h.

◆ WithSourceType() [1/2]

DescribeEventsRequest& Aws::ElastiCache::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 122 of file DescribeEventsRequest.h.

◆ WithSourceType() [2/2]

DescribeEventsRequest& Aws::ElastiCache::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 128 of file DescribeEventsRequest.h.

◆ WithStartTime() [1/2]

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 159 of file DescribeEventsRequest.h.

◆ WithStartTime() [2/2]

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

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

Example: 2017-03-30T07:03:49.555Z

Definition at line 165 of file DescribeEventsRequest.h.


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