AWS SDK for C++  1.9.75
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::DocDB::Model::DescribeGlobalClustersRequest Class Reference

#include <DescribeGlobalClustersRequest.h>

+ Inheritance diagram for Aws::DocDB::Model::DescribeGlobalClustersRequest:

Public Member Functions

 DescribeGlobalClustersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetGlobalClusterIdentifier () const
 
bool GlobalClusterIdentifierHasBeenSet () const
 
void SetGlobalClusterIdentifier (const Aws::String &value)
 
void SetGlobalClusterIdentifier (Aws::String &&value)
 
void SetGlobalClusterIdentifier (const char *value)
 
DescribeGlobalClustersRequestWithGlobalClusterIdentifier (const Aws::String &value)
 
DescribeGlobalClustersRequestWithGlobalClusterIdentifier (Aws::String &&value)
 
DescribeGlobalClustersRequestWithGlobalClusterIdentifier (const char *value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeGlobalClustersRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeGlobalClustersRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeGlobalClustersRequestAddFilters (const Filter &value)
 
DescribeGlobalClustersRequestAddFilters (Filter &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeGlobalClustersRequestWithMaxRecords (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)
 
DescribeGlobalClustersRequestWithMarker (const Aws::String &value)
 
DescribeGlobalClustersRequestWithMarker (Aws::String &&value)
 
DescribeGlobalClustersRequestWithMarker (const char *value)
 
- Public Member Functions inherited from Aws::DocDB::DocDBRequest
virtual ~DocDBRequest ()
 
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::DocDB::DocDBRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 23 of file DescribeGlobalClustersRequest.h.

Constructor & Destructor Documentation

◆ DescribeGlobalClustersRequest()

Aws::DocDB::Model::DescribeGlobalClustersRequest::DescribeGlobalClustersRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::AddFilters ( const Filter value)
inline

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Definition at line 152 of file DescribeGlobalClustersRequest.h.

◆ AddFilters() [2/2]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::AddFilters ( Filter &&  value)
inline

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Definition at line 160 of file DescribeGlobalClustersRequest.h.

◆ DumpBodyToUrl()

void Aws::DocDB::Model::DescribeGlobalClustersRequest::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.

◆ FiltersHasBeenSet()

bool Aws::DocDB::Model::DescribeGlobalClustersRequest::FiltersHasBeenSet ( ) const
inline

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Definition at line 112 of file DescribeGlobalClustersRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::DocDB::Model::DescribeGlobalClustersRequest::GetFilters ( ) const
inline

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Definition at line 104 of file DescribeGlobalClustersRequest.h.

◆ GetGlobalClusterIdentifier()

const Aws::String& Aws::DocDB::Model::DescribeGlobalClustersRequest::GetGlobalClusterIdentifier ( ) const
inline

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

Definition at line 46 of file DescribeGlobalClustersRequest.h.

◆ GetMarker()

const Aws::String& Aws::DocDB::Model::DescribeGlobalClustersRequest::GetMarker ( ) const
inline

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 202 of file DescribeGlobalClustersRequest.h.

◆ GetMaxRecords()

int Aws::DocDB::Model::DescribeGlobalClustersRequest::GetMaxRecords ( ) const
inline

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

Definition at line 169 of file DescribeGlobalClustersRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DocDB::Model::DescribeGlobalClustersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeGlobalClustersRequest.h.

◆ GlobalClusterIdentifierHasBeenSet()

bool Aws::DocDB::Model::DescribeGlobalClustersRequest::GlobalClusterIdentifierHasBeenSet ( ) const
inline

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

Definition at line 53 of file DescribeGlobalClustersRequest.h.

◆ MarkerHasBeenSet()

bool Aws::DocDB::Model::DescribeGlobalClustersRequest::MarkerHasBeenSet ( ) const
inline

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 210 of file DescribeGlobalClustersRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::DocDB::Model::DescribeGlobalClustersRequest::MaxRecordsHasBeenSet ( ) const
inline

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

Definition at line 177 of file DescribeGlobalClustersRequest.h.

◆ SerializePayload()

Aws::String Aws::DocDB::Model::DescribeGlobalClustersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Definition at line 128 of file DescribeGlobalClustersRequest.h.

◆ SetFilters() [2/2]

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Definition at line 120 of file DescribeGlobalClustersRequest.h.

◆ SetGlobalClusterIdentifier() [1/3]

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetGlobalClusterIdentifier ( Aws::String &&  value)
inline

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

Definition at line 67 of file DescribeGlobalClustersRequest.h.

◆ SetGlobalClusterIdentifier() [2/3]

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetGlobalClusterIdentifier ( const Aws::String value)
inline

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

Definition at line 60 of file DescribeGlobalClustersRequest.h.

◆ SetGlobalClusterIdentifier() [3/3]

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetGlobalClusterIdentifier ( const char *  value)
inline

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

Definition at line 74 of file DescribeGlobalClustersRequest.h.

◆ SetMarker() [1/3]

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetMarker ( Aws::String &&  value)
inline

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 226 of file DescribeGlobalClustersRequest.h.

◆ SetMarker() [2/3]

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetMarker ( const Aws::String value)
inline

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 218 of file DescribeGlobalClustersRequest.h.

◆ SetMarker() [3/3]

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetMarker ( const char *  value)
inline

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 234 of file DescribeGlobalClustersRequest.h.

◆ SetMaxRecords()

void Aws::DocDB::Model::DescribeGlobalClustersRequest::SetMaxRecords ( int  value)
inline

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

Definition at line 185 of file DescribeGlobalClustersRequest.h.

◆ WithFilters() [1/2]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Definition at line 144 of file DescribeGlobalClustersRequest.h.

◆ WithFilters() [2/2]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Definition at line 136 of file DescribeGlobalClustersRequest.h.

◆ WithGlobalClusterIdentifier() [1/3]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithGlobalClusterIdentifier ( Aws::String &&  value)
inline

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

Definition at line 88 of file DescribeGlobalClustersRequest.h.

◆ WithGlobalClusterIdentifier() [2/3]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithGlobalClusterIdentifier ( const Aws::String value)
inline

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

Definition at line 81 of file DescribeGlobalClustersRequest.h.

◆ WithGlobalClusterIdentifier() [3/3]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithGlobalClusterIdentifier ( const char *  value)
inline

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

Definition at line 95 of file DescribeGlobalClustersRequest.h.

◆ WithMarker() [1/3]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithMarker ( Aws::String &&  value)
inline

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 250 of file DescribeGlobalClustersRequest.h.

◆ WithMarker() [2/3]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithMarker ( const Aws::String value)
inline

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 242 of file DescribeGlobalClustersRequest.h.

◆ WithMarker() [3/3]

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithMarker ( const char *  value)
inline

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 258 of file DescribeGlobalClustersRequest.h.

◆ WithMaxRecords()

DescribeGlobalClustersRequest& Aws::DocDB::Model::DescribeGlobalClustersRequest::WithMaxRecords ( int  value)
inline

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

Definition at line 193 of file DescribeGlobalClustersRequest.h.


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