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

#include <StopTaskRequest.h>

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

Public Member Functions

 StopTaskRequest ()
 
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)
 
StopTaskRequestWithCluster (const Aws::String &value)
 
StopTaskRequestWithCluster (Aws::String &&value)
 
StopTaskRequestWithCluster (const char *value)
 
const Aws::StringGetTask () const
 
bool TaskHasBeenSet () const
 
void SetTask (const Aws::String &value)
 
void SetTask (Aws::String &&value)
 
void SetTask (const char *value)
 
StopTaskRequestWithTask (const Aws::String &value)
 
StopTaskRequestWithTask (Aws::String &&value)
 
StopTaskRequestWithTask (const char *value)
 
const Aws::StringGetReason () const
 
bool ReasonHasBeenSet () const
 
void SetReason (const Aws::String &value)
 
void SetReason (Aws::String &&value)
 
void SetReason (const char *value)
 
StopTaskRequestWithReason (const Aws::String &value)
 
StopTaskRequestWithReason (Aws::String &&value)
 
StopTaskRequestWithReason (const char *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 21 of file StopTaskRequest.h.

Constructor & Destructor Documentation

◆ StopTaskRequest()

Aws::ECS::Model::StopTaskRequest::StopTaskRequest ( )

Member Function Documentation

◆ ClusterHasBeenSet()

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Definition at line 49 of file StopTaskRequest.h.

◆ GetCluster()

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Definition at line 42 of file StopTaskRequest.h.

◆ GetReason()

const Aws::String& Aws::ECS::Model::StopTaskRequest::GetReason ( ) const
inline

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Definition at line 142 of file StopTaskRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file StopTaskRequest.h.

◆ GetTask()

const Aws::String& Aws::ECS::Model::StopTaskRequest::GetTask ( ) const
inline

The task ID or full Amazon Resource Name (ARN) of the task to stop.

Definition at line 97 of file StopTaskRequest.h.

◆ ReasonHasBeenSet()

bool Aws::ECS::Model::StopTaskRequest::ReasonHasBeenSet ( ) const
inline

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Definition at line 151 of file StopTaskRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCluster() [1/3]

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Definition at line 56 of file StopTaskRequest.h.

◆ SetCluster() [2/3]

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Definition at line 63 of file StopTaskRequest.h.

◆ SetCluster() [3/3]

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Definition at line 70 of file StopTaskRequest.h.

◆ SetReason() [1/3]

void Aws::ECS::Model::StopTaskRequest::SetReason ( const Aws::String value)
inline

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Definition at line 160 of file StopTaskRequest.h.

◆ SetReason() [2/3]

void Aws::ECS::Model::StopTaskRequest::SetReason ( Aws::String &&  value)
inline

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Definition at line 169 of file StopTaskRequest.h.

◆ SetReason() [3/3]

void Aws::ECS::Model::StopTaskRequest::SetReason ( const char *  value)
inline

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Definition at line 178 of file StopTaskRequest.h.

◆ SetTask() [1/3]

void Aws::ECS::Model::StopTaskRequest::SetTask ( const Aws::String value)
inline

The task ID or full Amazon Resource Name (ARN) of the task to stop.

Definition at line 107 of file StopTaskRequest.h.

◆ SetTask() [2/3]

void Aws::ECS::Model::StopTaskRequest::SetTask ( Aws::String &&  value)
inline

The task ID or full Amazon Resource Name (ARN) of the task to stop.

Definition at line 112 of file StopTaskRequest.h.

◆ SetTask() [3/3]

void Aws::ECS::Model::StopTaskRequest::SetTask ( const char *  value)
inline

The task ID or full Amazon Resource Name (ARN) of the task to stop.

Definition at line 117 of file StopTaskRequest.h.

◆ TaskHasBeenSet()

bool Aws::ECS::Model::StopTaskRequest::TaskHasBeenSet ( ) const
inline

The task ID or full Amazon Resource Name (ARN) of the task to stop.

Definition at line 102 of file StopTaskRequest.h.

◆ WithCluster() [1/3]

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Definition at line 77 of file StopTaskRequest.h.

◆ WithCluster() [2/3]

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Definition at line 84 of file StopTaskRequest.h.

◆ WithCluster() [3/3]

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Definition at line 91 of file StopTaskRequest.h.

◆ WithReason() [1/3]

StopTaskRequest& Aws::ECS::Model::StopTaskRequest::WithReason ( const Aws::String value)
inline

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Definition at line 187 of file StopTaskRequest.h.

◆ WithReason() [2/3]

StopTaskRequest& Aws::ECS::Model::StopTaskRequest::WithReason ( Aws::String &&  value)
inline

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Definition at line 196 of file StopTaskRequest.h.

◆ WithReason() [3/3]

StopTaskRequest& Aws::ECS::Model::StopTaskRequest::WithReason ( const char *  value)
inline

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Definition at line 205 of file StopTaskRequest.h.

◆ WithTask() [1/3]

StopTaskRequest& Aws::ECS::Model::StopTaskRequest::WithTask ( const Aws::String value)
inline

The task ID or full Amazon Resource Name (ARN) of the task to stop.

Definition at line 122 of file StopTaskRequest.h.

◆ WithTask() [2/3]

StopTaskRequest& Aws::ECS::Model::StopTaskRequest::WithTask ( Aws::String &&  value)
inline

The task ID or full Amazon Resource Name (ARN) of the task to stop.

Definition at line 127 of file StopTaskRequest.h.

◆ WithTask() [3/3]

StopTaskRequest& Aws::ECS::Model::StopTaskRequest::WithTask ( const char *  value)
inline

The task ID or full Amazon Resource Name (ARN) of the task to stop.

Definition at line 132 of file StopTaskRequest.h.


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