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

#include <DescribeCacheClustersRequest.h>

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

Public Member Functions

 DescribeCacheClustersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetCacheClusterId () const
 
bool CacheClusterIdHasBeenSet () const
 
void SetCacheClusterId (const Aws::String &value)
 
void SetCacheClusterId (Aws::String &&value)
 
void SetCacheClusterId (const char *value)
 
DescribeCacheClustersRequestWithCacheClusterId (const Aws::String &value)
 
DescribeCacheClustersRequestWithCacheClusterId (Aws::String &&value)
 
DescribeCacheClustersRequestWithCacheClusterId (const char *value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeCacheClustersRequestWithMaxRecords (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)
 
DescribeCacheClustersRequestWithMarker (const Aws::String &value)
 
DescribeCacheClustersRequestWithMarker (Aws::String &&value)
 
DescribeCacheClustersRequestWithMarker (const char *value)
 
bool GetShowCacheNodeInfo () const
 
bool ShowCacheNodeInfoHasBeenSet () const
 
void SetShowCacheNodeInfo (bool value)
 
DescribeCacheClustersRequestWithShowCacheNodeInfo (bool value)
 
bool GetShowCacheClustersNotInReplicationGroups () const
 
bool ShowCacheClustersNotInReplicationGroupsHasBeenSet () const
 
void SetShowCacheClustersNotInReplicationGroups (bool value)
 
DescribeCacheClustersRequestWithShowCacheClustersNotInReplicationGroups (bool 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 DescribeCacheClusters operation.

See Also:

AWS API Reference

Definition at line 25 of file DescribeCacheClustersRequest.h.

Constructor & Destructor Documentation

◆ DescribeCacheClustersRequest()

Aws::ElastiCache::Model::DescribeCacheClustersRequest::DescribeCacheClustersRequest ( )

Member Function Documentation

◆ CacheClusterIdHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheClustersRequest::CacheClusterIdHasBeenSet ( ) const
inline

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

Definition at line 55 of file DescribeCacheClustersRequest.h.

◆ DumpBodyToUrl()

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

◆ GetCacheClusterId()

const Aws::String& Aws::ElastiCache::Model::DescribeCacheClustersRequest::GetCacheClusterId ( ) const
inline

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

Definition at line 48 of file DescribeCacheClustersRequest.h.

◆ GetMarker()

const Aws::String& Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 139 of file DescribeCacheClustersRequest.h.

◆ GetMaxRecords()

int Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 106 of file DescribeCacheClustersRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeCacheClustersRequest.h.

◆ GetShowCacheClustersNotInReplicationGroups()

bool Aws::ElastiCache::Model::DescribeCacheClustersRequest::GetShowCacheClustersNotInReplicationGroups ( ) const
inline

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Definition at line 233 of file DescribeCacheClustersRequest.h.

◆ GetShowCacheNodeInfo()

bool Aws::ElastiCache::Model::DescribeCacheClustersRequest::GetShowCacheNodeInfo ( ) const
inline

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Definition at line 203 of file DescribeCacheClustersRequest.h.

◆ MarkerHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 147 of file DescribeCacheClustersRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 114 of file DescribeCacheClustersRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCacheClusterId() [1/3]

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::SetCacheClusterId ( const Aws::String value)
inline

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

Definition at line 62 of file DescribeCacheClustersRequest.h.

◆ SetCacheClusterId() [2/3]

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::SetCacheClusterId ( Aws::String &&  value)
inline

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

Definition at line 69 of file DescribeCacheClustersRequest.h.

◆ SetCacheClusterId() [3/3]

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::SetCacheClusterId ( const char *  value)
inline

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

Definition at line 76 of file DescribeCacheClustersRequest.h.

◆ SetMarker() [1/3]

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 155 of file DescribeCacheClustersRequest.h.

◆ SetMarker() [2/3]

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 163 of file DescribeCacheClustersRequest.h.

◆ SetMarker() [3/3]

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 171 of file DescribeCacheClustersRequest.h.

◆ SetMaxRecords()

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 122 of file DescribeCacheClustersRequest.h.

◆ SetShowCacheClustersNotInReplicationGroups()

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::SetShowCacheClustersNotInReplicationGroups ( bool  value)
inline

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Definition at line 249 of file DescribeCacheClustersRequest.h.

◆ SetShowCacheNodeInfo()

void Aws::ElastiCache::Model::DescribeCacheClustersRequest::SetShowCacheNodeInfo ( bool  value)
inline

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Definition at line 217 of file DescribeCacheClustersRequest.h.

◆ ShowCacheClustersNotInReplicationGroupsHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheClustersRequest::ShowCacheClustersNotInReplicationGroupsHasBeenSet ( ) const
inline

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Definition at line 241 of file DescribeCacheClustersRequest.h.

◆ ShowCacheNodeInfoHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheClustersRequest::ShowCacheNodeInfoHasBeenSet ( ) const
inline

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Definition at line 210 of file DescribeCacheClustersRequest.h.

◆ WithCacheClusterId() [1/3]

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::WithCacheClusterId ( const Aws::String value)
inline

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

Definition at line 83 of file DescribeCacheClustersRequest.h.

◆ WithCacheClusterId() [2/3]

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::WithCacheClusterId ( Aws::String &&  value)
inline

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

Definition at line 90 of file DescribeCacheClustersRequest.h.

◆ WithCacheClusterId() [3/3]

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::WithCacheClusterId ( const char *  value)
inline

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

Definition at line 97 of file DescribeCacheClustersRequest.h.

◆ WithMarker() [1/3]

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 179 of file DescribeCacheClustersRequest.h.

◆ WithMarker() [2/3]

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 187 of file DescribeCacheClustersRequest.h.

◆ WithMarker() [3/3]

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 195 of file DescribeCacheClustersRequest.h.

◆ WithMaxRecords()

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::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 130 of file DescribeCacheClustersRequest.h.

◆ WithShowCacheClustersNotInReplicationGroups()

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::WithShowCacheClustersNotInReplicationGroups ( bool  value)
inline

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Definition at line 257 of file DescribeCacheClustersRequest.h.

◆ WithShowCacheNodeInfo()

DescribeCacheClustersRequest& Aws::ElastiCache::Model::DescribeCacheClustersRequest::WithShowCacheNodeInfo ( bool  value)
inline

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Definition at line 224 of file DescribeCacheClustersRequest.h.


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