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

#include <DescribeTasksRequest.h>

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

Public Member Functions

 DescribeTasksRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCluster () const
 
bool ClusterHasBeenSet () const
 
void SetCluster (const Aws::String &value)
 
void SetCluster (Aws::String &&value)
 
void SetCluster (const char *value)
 
DescribeTasksRequestWithCluster (const Aws::String &value)
 
DescribeTasksRequestWithCluster (Aws::String &&value)
 
DescribeTasksRequestWithCluster (const char *value)
 
const Aws::Vector< Aws::String > & GetTasks () const
 
bool TasksHasBeenSet () const
 
void SetTasks (const Aws::Vector< Aws::String > &value)
 
void SetTasks (Aws::Vector< Aws::String > &&value)
 
DescribeTasksRequestWithTasks (const Aws::Vector< Aws::String > &value)
 
DescribeTasksRequestWithTasks (Aws::Vector< Aws::String > &&value)
 
DescribeTasksRequestAddTasks (const Aws::String &value)
 
DescribeTasksRequestAddTasks (Aws::String &&value)
 
DescribeTasksRequestAddTasks (const char *value)
 
const Aws::Vector< TaskField > & GetInclude () const
 
bool IncludeHasBeenSet () const
 
void SetInclude (const Aws::Vector< TaskField > &value)
 
void SetInclude (Aws::Vector< TaskField > &&value)
 
DescribeTasksRequestWithInclude (const Aws::Vector< TaskField > &value)
 
DescribeTasksRequestWithInclude (Aws::Vector< TaskField > &&value)
 
DescribeTasksRequestAddInclude (const TaskField &value)
 
DescribeTasksRequestAddInclude (TaskField &&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 DescribeTasksRequest.h.

Constructor & Destructor Documentation

◆ DescribeTasksRequest()

Aws::ECS::Model::DescribeTasksRequest::DescribeTasksRequest ( )

Member Function Documentation

◆ AddInclude() [1/2]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::AddInclude ( const TaskField value)
inline

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 197 of file DescribeTasksRequest.h.

◆ AddInclude() [2/2]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::AddInclude ( TaskField &&  value)
inline

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 204 of file DescribeTasksRequest.h.

◆ AddTasks() [1/3]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::AddTasks ( const Aws::String value)
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 137 of file DescribeTasksRequest.h.

◆ AddTasks() [2/3]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::AddTasks ( Aws::String &&  value)
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 142 of file DescribeTasksRequest.h.

◆ AddTasks() [3/3]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::AddTasks ( const char *  value)
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 147 of file DescribeTasksRequest.h.

◆ ClusterHasBeenSet()

bool Aws::ECS::Model::DescribeTasksRequest::ClusterHasBeenSet ( ) const
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

Definition at line 53 of file DescribeTasksRequest.h.

◆ GetCluster()

const Aws::String& Aws::ECS::Model::DescribeTasksRequest::GetCluster ( ) const
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

Definition at line 45 of file DescribeTasksRequest.h.

◆ GetInclude()

const Aws::Vector<TaskField>& Aws::ECS::Model::DescribeTasksRequest::GetInclude ( ) const
inline

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 155 of file DescribeTasksRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeTasksRequest.h.

◆ GetTasks()

const Aws::Vector<Aws::String>& Aws::ECS::Model::DescribeTasksRequest::GetTasks ( ) const
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 107 of file DescribeTasksRequest.h.

◆ IncludeHasBeenSet()

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

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 162 of file DescribeTasksRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCluster() [1/3]

void Aws::ECS::Model::DescribeTasksRequest::SetCluster ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

Definition at line 61 of file DescribeTasksRequest.h.

◆ SetCluster() [2/3]

void Aws::ECS::Model::DescribeTasksRequest::SetCluster ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

Definition at line 69 of file DescribeTasksRequest.h.

◆ SetCluster() [3/3]

void Aws::ECS::Model::DescribeTasksRequest::SetCluster ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

Definition at line 77 of file DescribeTasksRequest.h.

◆ SetInclude() [1/2]

void Aws::ECS::Model::DescribeTasksRequest::SetInclude ( const Aws::Vector< TaskField > &  value)
inline

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 169 of file DescribeTasksRequest.h.

◆ SetInclude() [2/2]

void Aws::ECS::Model::DescribeTasksRequest::SetInclude ( Aws::Vector< TaskField > &&  value)
inline

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 176 of file DescribeTasksRequest.h.

◆ SetTasks() [1/2]

void Aws::ECS::Model::DescribeTasksRequest::SetTasks ( const Aws::Vector< Aws::String > &  value)
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 117 of file DescribeTasksRequest.h.

◆ SetTasks() [2/2]

void Aws::ECS::Model::DescribeTasksRequest::SetTasks ( Aws::Vector< Aws::String > &&  value)
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 122 of file DescribeTasksRequest.h.

◆ TasksHasBeenSet()

bool Aws::ECS::Model::DescribeTasksRequest::TasksHasBeenSet ( ) const
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 112 of file DescribeTasksRequest.h.

◆ WithCluster() [1/3]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::WithCluster ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

Definition at line 85 of file DescribeTasksRequest.h.

◆ WithCluster() [2/3]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::WithCluster ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

Definition at line 93 of file DescribeTasksRequest.h.

◆ WithCluster() [3/3]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::WithCluster ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

Definition at line 101 of file DescribeTasksRequest.h.

◆ WithInclude() [1/2]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::WithInclude ( const Aws::Vector< TaskField > &  value)
inline

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 183 of file DescribeTasksRequest.h.

◆ WithInclude() [2/2]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::WithInclude ( Aws::Vector< TaskField > &&  value)
inline

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 190 of file DescribeTasksRequest.h.

◆ WithTasks() [1/2]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::WithTasks ( const Aws::Vector< Aws::String > &  value)
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 127 of file DescribeTasksRequest.h.

◆ WithTasks() [2/2]

DescribeTasksRequest& Aws::ECS::Model::DescribeTasksRequest::WithTasks ( Aws::Vector< Aws::String > &&  value)
inline

A list of up to 100 task IDs or full ARN entries.

Definition at line 132 of file DescribeTasksRequest.h.


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