AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::DescribeClustersRequest Class Reference

#include <DescribeClustersRequest.h>

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

Public Member Functions

 DescribeClustersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetClusters () const
 
bool ClustersHasBeenSet () const
 
void SetClusters (const Aws::Vector< Aws::String > &value)
 
void SetClusters (Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestWithClusters (const Aws::Vector< Aws::String > &value)
 
DescribeClustersRequestWithClusters (Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestAddClusters (const Aws::String &value)
 
DescribeClustersRequestAddClusters (Aws::String &&value)
 
DescribeClustersRequestAddClusters (const char *value)
 
const Aws::Vector< ClusterField > & GetInclude () const
 
bool IncludeHasBeenSet () const
 
void SetInclude (const Aws::Vector< ClusterField > &value)
 
void SetInclude (Aws::Vector< ClusterField > &&value)
 
DescribeClustersRequestWithInclude (const Aws::Vector< ClusterField > &value)
 
DescribeClustersRequestWithInclude (Aws::Vector< ClusterField > &&value)
 
DescribeClustersRequestAddInclude (const ClusterField &value)
 
DescribeClustersRequestAddInclude (ClusterField &&value)
 
- Public Member Functions inherited from Aws::ECS::ECSRequest
virtual ~ECSRequest ()
 
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 DescribeClustersRequest.h.

Constructor & Destructor Documentation

◆ DescribeClustersRequest()

Aws::ECS::Model::DescribeClustersRequest::DescribeClustersRequest ( )

Member Function Documentation

◆ AddClusters() [1/3]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::AddClusters ( const Aws::String value)
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 79 of file DescribeClustersRequest.h.

◆ AddClusters() [2/3]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::AddClusters ( Aws::String &&  value)
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 85 of file DescribeClustersRequest.h.

◆ AddClusters() [3/3]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::AddClusters ( const char *  value)
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 91 of file DescribeClustersRequest.h.

◆ AddInclude() [1/2]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::AddInclude ( const ClusterField value)
inline

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Definition at line 211 of file DescribeClustersRequest.h.

◆ AddInclude() [2/2]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::AddInclude ( ClusterField &&  value)
inline

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Definition at line 228 of file DescribeClustersRequest.h.

◆ ClustersHasBeenSet()

bool Aws::ECS::Model::DescribeClustersRequest::ClustersHasBeenSet ( ) const
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 49 of file DescribeClustersRequest.h.

◆ GetClusters()

const Aws::Vector<Aws::String>& Aws::ECS::Model::DescribeClustersRequest::GetClusters ( ) const
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 43 of file DescribeClustersRequest.h.

◆ GetInclude()

const Aws::Vector<ClusterField>& Aws::ECS::Model::DescribeClustersRequest::GetInclude ( ) const
inline

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Definition at line 109 of file DescribeClustersRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::DescribeClustersRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeClustersRequest.h.

◆ IncludeHasBeenSet()

bool Aws::ECS::Model::DescribeClustersRequest::IncludeHasBeenSet ( ) const
inline

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Definition at line 126 of file DescribeClustersRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusters() [1/2]

void Aws::ECS::Model::DescribeClustersRequest::SetClusters ( const Aws::Vector< Aws::String > &  value)
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 55 of file DescribeClustersRequest.h.

◆ SetClusters() [2/2]

void Aws::ECS::Model::DescribeClustersRequest::SetClusters ( Aws::Vector< Aws::String > &&  value)
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 61 of file DescribeClustersRequest.h.

◆ SetInclude() [1/2]

void Aws::ECS::Model::DescribeClustersRequest::SetInclude ( const Aws::Vector< ClusterField > &  value)
inline

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Definition at line 143 of file DescribeClustersRequest.h.

◆ SetInclude() [2/2]

void Aws::ECS::Model::DescribeClustersRequest::SetInclude ( Aws::Vector< ClusterField > &&  value)
inline

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Definition at line 160 of file DescribeClustersRequest.h.

◆ WithClusters() [1/2]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::WithClusters ( const Aws::Vector< Aws::String > &  value)
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 67 of file DescribeClustersRequest.h.

◆ WithClusters() [2/2]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::WithClusters ( Aws::Vector< Aws::String > &&  value)
inline

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Definition at line 73 of file DescribeClustersRequest.h.

◆ WithInclude() [1/2]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::WithInclude ( const Aws::Vector< ClusterField > &  value)
inline

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Definition at line 177 of file DescribeClustersRequest.h.

◆ WithInclude() [2/2]

DescribeClustersRequest& Aws::ECS::Model::DescribeClustersRequest::WithInclude ( Aws::Vector< ClusterField > &&  value)
inline

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Definition at line 194 of file DescribeClustersRequest.h.


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