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

#include <DescribeClustersRequest.h>

+ Inheritance diagram for Aws::Redshift::Model::DescribeClustersRequest:

Public Member Functions

 DescribeClustersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
DescribeClustersRequestWithClusterIdentifier (const Aws::String &value)
 
DescribeClustersRequestWithClusterIdentifier (Aws::String &&value)
 
DescribeClustersRequestWithClusterIdentifier (const char *value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeClustersRequestWithMaxRecords (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)
 
DescribeClustersRequestWithMarker (const Aws::String &value)
 
DescribeClustersRequestWithMarker (Aws::String &&value)
 
DescribeClustersRequestWithMarker (const char *value)
 
const Aws::Vector< Aws::String > & GetTagKeys () const
 
bool TagKeysHasBeenSet () const
 
void SetTagKeys (const Aws::Vector< Aws::String > &value)
 
void SetTagKeys (Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestWithTagKeys (const Aws::Vector< Aws::String > &value)
 
DescribeClustersRequestWithTagKeys (Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestAddTagKeys (const Aws::String &value)
 
DescribeClustersRequestAddTagKeys (Aws::String &&value)
 
DescribeClustersRequestAddTagKeys (const char *value)
 
const Aws::Vector< Aws::String > & GetTagValues () const
 
bool TagValuesHasBeenSet () const
 
void SetTagValues (const Aws::Vector< Aws::String > &value)
 
void SetTagValues (Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestWithTagValues (const Aws::Vector< Aws::String > &value)
 
DescribeClustersRequestWithTagValues (Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestAddTagValues (const Aws::String &value)
 
DescribeClustersRequestAddTagValues (Aws::String &&value)
 
DescribeClustersRequestAddTagValues (const char *value)
 
- Public Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual ~RedshiftRequest ()
 
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::Redshift::RedshiftRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 25 of file DescribeClustersRequest.h.

Constructor & Destructor Documentation

◆ DescribeClustersRequest()

Aws::Redshift::Model::DescribeClustersRequest::DescribeClustersRequest ( )

Member Function Documentation

◆ AddTagKeys() [1/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::AddTagKeys ( const Aws::String value)
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 306 of file DescribeClustersRequest.h.

◆ AddTagKeys() [2/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::AddTagKeys ( Aws::String &&  value)
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 316 of file DescribeClustersRequest.h.

◆ AddTagKeys() [3/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::AddTagKeys ( const char *  value)
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 326 of file DescribeClustersRequest.h.

◆ AddTagValues() [1/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::AddTagValues ( const Aws::String value)
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 397 of file DescribeClustersRequest.h.

◆ AddTagValues() [2/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::AddTagValues ( Aws::String &&  value)
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 407 of file DescribeClustersRequest.h.

◆ AddTagValues() [3/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::AddTagValues ( const char *  value)
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 417 of file DescribeClustersRequest.h.

◆ ClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::DescribeClustersRequest::ClusterIdentifierHasBeenSet ( ) const
inline

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Definition at line 55 of file DescribeClustersRequest.h.

◆ DumpBodyToUrl()

void Aws::Redshift::Model::DescribeClustersRequest::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.

◆ GetClusterIdentifier()

const Aws::String& Aws::Redshift::Model::DescribeClustersRequest::GetClusterIdentifier ( ) const
inline

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Definition at line 48 of file DescribeClustersRequest.h.

◆ GetMarker()

const Aws::String& Aws::Redshift::Model::DescribeClustersRequest::GetMarker ( ) const
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Definition at line 151 of file DescribeClustersRequest.h.

◆ GetMaxRecords()

int Aws::Redshift::Model::DescribeClustersRequest::GetMaxRecords ( ) const
inline

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Definition at line 108 of file DescribeClustersRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Redshift::Model::DescribeClustersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeClustersRequest.h.

◆ GetTagKeys()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::DescribeClustersRequest::GetTagKeys ( ) const
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 246 of file DescribeClustersRequest.h.

◆ GetTagValues()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::DescribeClustersRequest::GetTagValues ( ) const
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 337 of file DescribeClustersRequest.h.

◆ MarkerHasBeenSet()

bool Aws::Redshift::Model::DescribeClustersRequest::MarkerHasBeenSet ( ) const
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Definition at line 163 of file DescribeClustersRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::Redshift::Model::DescribeClustersRequest::MaxRecordsHasBeenSet ( ) const
inline

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Definition at line 118 of file DescribeClustersRequest.h.

◆ SerializePayload()

Aws::String Aws::Redshift::Model::DescribeClustersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusterIdentifier() [1/3]

void Aws::Redshift::Model::DescribeClustersRequest::SetClusterIdentifier ( const Aws::String value)
inline

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Definition at line 62 of file DescribeClustersRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::Redshift::Model::DescribeClustersRequest::SetClusterIdentifier ( Aws::String &&  value)
inline

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Definition at line 69 of file DescribeClustersRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::Redshift::Model::DescribeClustersRequest::SetClusterIdentifier ( const char *  value)
inline

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Definition at line 76 of file DescribeClustersRequest.h.

◆ SetMarker() [1/3]

void Aws::Redshift::Model::DescribeClustersRequest::SetMarker ( const Aws::String value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Definition at line 175 of file DescribeClustersRequest.h.

◆ SetMarker() [2/3]

void Aws::Redshift::Model::DescribeClustersRequest::SetMarker ( Aws::String &&  value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Definition at line 187 of file DescribeClustersRequest.h.

◆ SetMarker() [3/3]

void Aws::Redshift::Model::DescribeClustersRequest::SetMarker ( const char *  value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Definition at line 199 of file DescribeClustersRequest.h.

◆ SetMaxRecords()

void Aws::Redshift::Model::DescribeClustersRequest::SetMaxRecords ( int  value)
inline

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Definition at line 128 of file DescribeClustersRequest.h.

◆ SetTagKeys() [1/2]

void Aws::Redshift::Model::DescribeClustersRequest::SetTagKeys ( const Aws::Vector< Aws::String > &  value)
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 266 of file DescribeClustersRequest.h.

◆ SetTagKeys() [2/2]

void Aws::Redshift::Model::DescribeClustersRequest::SetTagKeys ( Aws::Vector< Aws::String > &&  value)
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 276 of file DescribeClustersRequest.h.

◆ SetTagValues() [1/2]

void Aws::Redshift::Model::DescribeClustersRequest::SetTagValues ( const Aws::Vector< Aws::String > &  value)
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 357 of file DescribeClustersRequest.h.

◆ SetTagValues() [2/2]

void Aws::Redshift::Model::DescribeClustersRequest::SetTagValues ( Aws::Vector< Aws::String > &&  value)
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 367 of file DescribeClustersRequest.h.

◆ TagKeysHasBeenSet()

bool Aws::Redshift::Model::DescribeClustersRequest::TagKeysHasBeenSet ( ) const
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 256 of file DescribeClustersRequest.h.

◆ TagValuesHasBeenSet()

bool Aws::Redshift::Model::DescribeClustersRequest::TagValuesHasBeenSet ( ) const
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 347 of file DescribeClustersRequest.h.

◆ WithClusterIdentifier() [1/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithClusterIdentifier ( const Aws::String value)
inline

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Definition at line 83 of file DescribeClustersRequest.h.

◆ WithClusterIdentifier() [2/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithClusterIdentifier ( Aws::String &&  value)
inline

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Definition at line 90 of file DescribeClustersRequest.h.

◆ WithClusterIdentifier() [3/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithClusterIdentifier ( const char *  value)
inline

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Definition at line 97 of file DescribeClustersRequest.h.

◆ WithMarker() [1/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithMarker ( const Aws::String value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Definition at line 211 of file DescribeClustersRequest.h.

◆ WithMarker() [2/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithMarker ( Aws::String &&  value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Definition at line 223 of file DescribeClustersRequest.h.

◆ WithMarker() [3/3]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithMarker ( const char *  value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Definition at line 235 of file DescribeClustersRequest.h.

◆ WithMaxRecords()

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithMaxRecords ( int  value)
inline

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Definition at line 138 of file DescribeClustersRequest.h.

◆ WithTagKeys() [1/2]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithTagKeys ( const Aws::Vector< Aws::String > &  value)
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 286 of file DescribeClustersRequest.h.

◆ WithTagKeys() [2/2]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithTagKeys ( Aws::Vector< Aws::String > &&  value)
inline

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Definition at line 296 of file DescribeClustersRequest.h.

◆ WithTagValues() [1/2]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithTagValues ( const Aws::Vector< Aws::String > &  value)
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 377 of file DescribeClustersRequest.h.

◆ WithTagValues() [2/2]

DescribeClustersRequest& Aws::Redshift::Model::DescribeClustersRequest::WithTagValues ( Aws::Vector< Aws::String > &&  value)
inline

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Definition at line 387 of file DescribeClustersRequest.h.


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