#include <CancelJobRequest.h>

Inheritance diagram for Aws::Batch::Model::CancelJobRequest:

Public Member Functions
	CancelJobRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

const Aws::String &	GetJobId () const

bool	JobIdHasBeenSet () const

void	SetJobId (const Aws::String &value)

void	SetJobId (Aws::String &&value)

void	SetJobId (const char *value)

CancelJobRequest &	WithJobId (const Aws::String &value)

CancelJobRequest &	WithJobId (Aws::String &&value)

CancelJobRequest &	WithJobId (const char *value)

const Aws::String &	GetReason () const

bool	ReasonHasBeenSet () const

void	SetReason (const Aws::String &value)

void	SetReason (Aws::String &&value)

void	SetReason (const char *value)

CancelJobRequest &	WithReason (const Aws::String &value)

CancelJobRequest &	WithReason (Aws::String &&value)

CancelJobRequest &	WithReason (const char *value)

Public Member Functions inherited from Aws::Batch::BatchRequest
virtual	~BatchRequest ()

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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () const

virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::Batch::BatchRequest
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const

Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Contains the parameters for CancelJob.

Constructor & Destructor Documentation

◆ CancelJobRequest()

Aws::Batch::Model::CancelJobRequest::CancelJobRequest ( )

Member Function Documentation

◆ GetJobId()

const Aws::String& Aws::Batch::Model::CancelJobRequest::GetJobId ( ) const

inline

The AWS Batch job ID of the job to cancel.

Definition at line 42 of file CancelJobRequest.h.

◆ GetReason()

const Aws::String& Aws::Batch::Model::CancelJobRequest::GetReason ( ) const

inline

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Definition at line 85 of file CancelJobRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Batch::Model::CancelJobRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CancelJobRequest.h.

◆ JobIdHasBeenSet()

bool Aws::Batch::Model::CancelJobRequest::JobIdHasBeenSet ( ) const

inline

The AWS Batch job ID of the job to cancel.

Definition at line 47 of file CancelJobRequest.h.

◆ ReasonHasBeenSet()

bool Aws::Batch::Model::CancelJobRequest::ReasonHasBeenSet ( ) const

inline

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Definition at line 92 of file CancelJobRequest.h.

◆ SerializePayload()

Aws::String Aws::Batch::Model::CancelJobRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobId() [1/3]

void Aws::Batch::Model::CancelJobRequest::SetJobId ( Aws::String && value )

inline

The AWS Batch job ID of the job to cancel.

Definition at line 57 of file CancelJobRequest.h.

◆ SetJobId() [2/3]

void Aws::Batch::Model::CancelJobRequest::SetJobId ( const Aws::String & value )

inline

The AWS Batch job ID of the job to cancel.

Definition at line 52 of file CancelJobRequest.h.

◆ SetJobId() [3/3]

void Aws::Batch::Model::CancelJobRequest::SetJobId ( const char * value )

inline

The AWS Batch job ID of the job to cancel.

Definition at line 62 of file CancelJobRequest.h.

◆ SetReason() [1/3]

void Aws::Batch::Model::CancelJobRequest::SetReason ( Aws::String && value )

inline

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Definition at line 106 of file CancelJobRequest.h.

◆ SetReason() [2/3]

void Aws::Batch::Model::CancelJobRequest::SetReason ( const Aws::String & value )

inline

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Definition at line 99 of file CancelJobRequest.h.

◆ SetReason() [3/3]

void Aws::Batch::Model::CancelJobRequest::SetReason ( const char * value )

inline

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Definition at line 113 of file CancelJobRequest.h.

◆ WithJobId() [1/3]

CancelJobRequest& Aws::Batch::Model::CancelJobRequest::WithJobId ( Aws::String && value )

inline

The AWS Batch job ID of the job to cancel.

Definition at line 72 of file CancelJobRequest.h.

◆ WithJobId() [2/3]

CancelJobRequest& Aws::Batch::Model::CancelJobRequest::WithJobId ( const Aws::String & value )

inline

The AWS Batch job ID of the job to cancel.

Definition at line 67 of file CancelJobRequest.h.

◆ WithJobId() [3/3]

CancelJobRequest& Aws::Batch::Model::CancelJobRequest::WithJobId ( const char * value )

inline

The AWS Batch job ID of the job to cancel.

Definition at line 77 of file CancelJobRequest.h.

◆ WithReason() [1/3]

CancelJobRequest& Aws::Batch::Model::CancelJobRequest::WithReason ( Aws::String && value )

inline

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Definition at line 127 of file CancelJobRequest.h.

◆ WithReason() [2/3]

CancelJobRequest& Aws::Batch::Model::CancelJobRequest::WithReason ( const Aws::String & value )

inline

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Definition at line 120 of file CancelJobRequest.h.

◆ WithReason() [3/3]

CancelJobRequest& Aws::Batch::Model::CancelJobRequest::WithReason ( const char * value )

inline

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Definition at line 134 of file CancelJobRequest.h.

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

aws-cpp-sdk-batch/include/aws/batch/model/CancelJobRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ CancelJobRequest()

Member Function Documentation

◆ GetJobId()

◆ GetReason()

◆ GetServiceRequestName()

◆ JobIdHasBeenSet()

◆ ReasonHasBeenSet()

◆ SerializePayload()

◆ SetJobId() [1/3]

◆ SetJobId() [2/3]

◆ SetJobId() [3/3]

◆ SetReason() [1/3]

◆ SetReason() [2/3]

◆ SetReason() [3/3]

◆ WithJobId() [1/3]

◆ WithJobId() [2/3]

◆ WithJobId() [3/3]

◆ WithReason() [1/3]

◆ WithReason() [2/3]

◆ WithReason() [3/3]