AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::SWF::Model::TerminateWorkflowExecutionRequest Class Reference

#include <TerminateWorkflowExecutionRequest.h>

+ Inheritance diagram for Aws::SWF::Model::TerminateWorkflowExecutionRequest:

Public Member Functions

 TerminateWorkflowExecutionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
TerminateWorkflowExecutionRequestWithDomain (const Aws::String &value)
 
TerminateWorkflowExecutionRequestWithDomain (Aws::String &&value)
 
TerminateWorkflowExecutionRequestWithDomain (const char *value)
 
const Aws::StringGetWorkflowId () const
 
bool WorkflowIdHasBeenSet () const
 
void SetWorkflowId (const Aws::String &value)
 
void SetWorkflowId (Aws::String &&value)
 
void SetWorkflowId (const char *value)
 
TerminateWorkflowExecutionRequestWithWorkflowId (const Aws::String &value)
 
TerminateWorkflowExecutionRequestWithWorkflowId (Aws::String &&value)
 
TerminateWorkflowExecutionRequestWithWorkflowId (const char *value)
 
const Aws::StringGetRunId () const
 
bool RunIdHasBeenSet () const
 
void SetRunId (const Aws::String &value)
 
void SetRunId (Aws::String &&value)
 
void SetRunId (const char *value)
 
TerminateWorkflowExecutionRequestWithRunId (const Aws::String &value)
 
TerminateWorkflowExecutionRequestWithRunId (Aws::String &&value)
 
TerminateWorkflowExecutionRequestWithRunId (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)
 
TerminateWorkflowExecutionRequestWithReason (const Aws::String &value)
 
TerminateWorkflowExecutionRequestWithReason (Aws::String &&value)
 
TerminateWorkflowExecutionRequestWithReason (const char *value)
 
const Aws::StringGetDetails () const
 
bool DetailsHasBeenSet () const
 
void SetDetails (const Aws::String &value)
 
void SetDetails (Aws::String &&value)
 
void SetDetails (const char *value)
 
TerminateWorkflowExecutionRequestWithDetails (const Aws::String &value)
 
TerminateWorkflowExecutionRequestWithDetails (Aws::String &&value)
 
TerminateWorkflowExecutionRequestWithDetails (const char *value)
 
const ChildPolicyGetChildPolicy () const
 
bool ChildPolicyHasBeenSet () const
 
void SetChildPolicy (const ChildPolicy &value)
 
void SetChildPolicy (ChildPolicy &&value)
 
TerminateWorkflowExecutionRequestWithChildPolicy (const ChildPolicy &value)
 
TerminateWorkflowExecutionRequestWithChildPolicy (ChildPolicy &&value)
 
- Public Member Functions inherited from Aws::SWF::SWFRequest
virtual ~SWFRequest ()
 
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 22 of file TerminateWorkflowExecutionRequest.h.

Constructor & Destructor Documentation

◆ TerminateWorkflowExecutionRequest()

Aws::SWF::Model::TerminateWorkflowExecutionRequest::TerminateWorkflowExecutionRequest ( )

Member Function Documentation

◆ ChildPolicyHasBeenSet()

bool Aws::SWF::Model::TerminateWorkflowExecutionRequest::ChildPolicyHasBeenSet ( ) const
inline

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 277 of file TerminateWorkflowExecutionRequest.h.

◆ DetailsHasBeenSet()

bool Aws::SWF::Model::TerminateWorkflowExecutionRequest::DetailsHasBeenSet ( ) const
inline

Details for terminating the workflow execution.

Definition at line 210 of file TerminateWorkflowExecutionRequest.h.

◆ DomainHasBeenSet()

bool Aws::SWF::Model::TerminateWorkflowExecutionRequest::DomainHasBeenSet ( ) const
inline

The domain of the workflow execution to terminate.

Definition at line 46 of file TerminateWorkflowExecutionRequest.h.

◆ GetChildPolicy()

const ChildPolicy& Aws::SWF::Model::TerminateWorkflowExecutionRequest::GetChildPolicy ( ) const
inline

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 259 of file TerminateWorkflowExecutionRequest.h.

◆ GetDetails()

const Aws::String& Aws::SWF::Model::TerminateWorkflowExecutionRequest::GetDetails ( ) const
inline

Details for terminating the workflow execution.

Definition at line 205 of file TerminateWorkflowExecutionRequest.h.

◆ GetDomain()

const Aws::String& Aws::SWF::Model::TerminateWorkflowExecutionRequest::GetDomain ( ) const
inline

The domain of the workflow execution to terminate.

Definition at line 41 of file TerminateWorkflowExecutionRequest.h.

◆ GetReason()

const Aws::String& Aws::SWF::Model::TerminateWorkflowExecutionRequest::GetReason ( ) const
inline

A descriptive reason for terminating the workflow execution.

Definition at line 164 of file TerminateWorkflowExecutionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SWF::Model::TerminateWorkflowExecutionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SWF::SWFRequest.

◆ GetRunId()

const Aws::String& Aws::SWF::Model::TerminateWorkflowExecutionRequest::GetRunId ( ) const
inline

The runId of the workflow execution to terminate.

Definition at line 123 of file TerminateWorkflowExecutionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SWF::Model::TerminateWorkflowExecutionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file TerminateWorkflowExecutionRequest.h.

◆ GetWorkflowId()

const Aws::String& Aws::SWF::Model::TerminateWorkflowExecutionRequest::GetWorkflowId ( ) const
inline

The workflowId of the workflow execution to terminate.

Definition at line 82 of file TerminateWorkflowExecutionRequest.h.

◆ ReasonHasBeenSet()

bool Aws::SWF::Model::TerminateWorkflowExecutionRequest::ReasonHasBeenSet ( ) const
inline

A descriptive reason for terminating the workflow execution.

Definition at line 169 of file TerminateWorkflowExecutionRequest.h.

◆ RunIdHasBeenSet()

bool Aws::SWF::Model::TerminateWorkflowExecutionRequest::RunIdHasBeenSet ( ) const
inline

The runId of the workflow execution to terminate.

Definition at line 128 of file TerminateWorkflowExecutionRequest.h.

◆ SerializePayload()

Aws::String Aws::SWF::Model::TerminateWorkflowExecutionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChildPolicy() [1/2]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetChildPolicy ( const ChildPolicy value)
inline

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 295 of file TerminateWorkflowExecutionRequest.h.

◆ SetChildPolicy() [2/2]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetChildPolicy ( ChildPolicy &&  value)
inline

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 313 of file TerminateWorkflowExecutionRequest.h.

◆ SetDetails() [1/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetDetails ( const Aws::String value)
inline

Details for terminating the workflow execution.

Definition at line 215 of file TerminateWorkflowExecutionRequest.h.

◆ SetDetails() [2/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetDetails ( Aws::String &&  value)
inline

Details for terminating the workflow execution.

Definition at line 220 of file TerminateWorkflowExecutionRequest.h.

◆ SetDetails() [3/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetDetails ( const char *  value)
inline

Details for terminating the workflow execution.

Definition at line 225 of file TerminateWorkflowExecutionRequest.h.

◆ SetDomain() [1/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetDomain ( const Aws::String value)
inline

The domain of the workflow execution to terminate.

Definition at line 51 of file TerminateWorkflowExecutionRequest.h.

◆ SetDomain() [2/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetDomain ( Aws::String &&  value)
inline

The domain of the workflow execution to terminate.

Definition at line 56 of file TerminateWorkflowExecutionRequest.h.

◆ SetDomain() [3/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetDomain ( const char *  value)
inline

The domain of the workflow execution to terminate.

Definition at line 61 of file TerminateWorkflowExecutionRequest.h.

◆ SetReason() [1/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetReason ( const Aws::String value)
inline

A descriptive reason for terminating the workflow execution.

Definition at line 174 of file TerminateWorkflowExecutionRequest.h.

◆ SetReason() [2/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetReason ( Aws::String &&  value)
inline

A descriptive reason for terminating the workflow execution.

Definition at line 179 of file TerminateWorkflowExecutionRequest.h.

◆ SetReason() [3/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetReason ( const char *  value)
inline

A descriptive reason for terminating the workflow execution.

Definition at line 184 of file TerminateWorkflowExecutionRequest.h.

◆ SetRunId() [1/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetRunId ( const Aws::String value)
inline

The runId of the workflow execution to terminate.

Definition at line 133 of file TerminateWorkflowExecutionRequest.h.

◆ SetRunId() [2/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetRunId ( Aws::String &&  value)
inline

The runId of the workflow execution to terminate.

Definition at line 138 of file TerminateWorkflowExecutionRequest.h.

◆ SetRunId() [3/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetRunId ( const char *  value)
inline

The runId of the workflow execution to terminate.

Definition at line 143 of file TerminateWorkflowExecutionRequest.h.

◆ SetWorkflowId() [1/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetWorkflowId ( const Aws::String value)
inline

The workflowId of the workflow execution to terminate.

Definition at line 92 of file TerminateWorkflowExecutionRequest.h.

◆ SetWorkflowId() [2/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetWorkflowId ( Aws::String &&  value)
inline

The workflowId of the workflow execution to terminate.

Definition at line 97 of file TerminateWorkflowExecutionRequest.h.

◆ SetWorkflowId() [3/3]

void Aws::SWF::Model::TerminateWorkflowExecutionRequest::SetWorkflowId ( const char *  value)
inline

The workflowId of the workflow execution to terminate.

Definition at line 102 of file TerminateWorkflowExecutionRequest.h.

◆ WithChildPolicy() [1/2]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithChildPolicy ( const ChildPolicy value)
inline

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 331 of file TerminateWorkflowExecutionRequest.h.

◆ WithChildPolicy() [2/2]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithChildPolicy ( ChildPolicy &&  value)
inline

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 349 of file TerminateWorkflowExecutionRequest.h.

◆ WithDetails() [1/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithDetails ( const Aws::String value)
inline

Details for terminating the workflow execution.

Definition at line 230 of file TerminateWorkflowExecutionRequest.h.

◆ WithDetails() [2/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithDetails ( Aws::String &&  value)
inline

Details for terminating the workflow execution.

Definition at line 235 of file TerminateWorkflowExecutionRequest.h.

◆ WithDetails() [3/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithDetails ( const char *  value)
inline

Details for terminating the workflow execution.

Definition at line 240 of file TerminateWorkflowExecutionRequest.h.

◆ WithDomain() [1/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithDomain ( const Aws::String value)
inline

The domain of the workflow execution to terminate.

Definition at line 66 of file TerminateWorkflowExecutionRequest.h.

◆ WithDomain() [2/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithDomain ( Aws::String &&  value)
inline

The domain of the workflow execution to terminate.

Definition at line 71 of file TerminateWorkflowExecutionRequest.h.

◆ WithDomain() [3/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithDomain ( const char *  value)
inline

The domain of the workflow execution to terminate.

Definition at line 76 of file TerminateWorkflowExecutionRequest.h.

◆ WithReason() [1/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithReason ( const Aws::String value)
inline

A descriptive reason for terminating the workflow execution.

Definition at line 189 of file TerminateWorkflowExecutionRequest.h.

◆ WithReason() [2/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithReason ( Aws::String &&  value)
inline

A descriptive reason for terminating the workflow execution.

Definition at line 194 of file TerminateWorkflowExecutionRequest.h.

◆ WithReason() [3/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithReason ( const char *  value)
inline

A descriptive reason for terminating the workflow execution.

Definition at line 199 of file TerminateWorkflowExecutionRequest.h.

◆ WithRunId() [1/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithRunId ( const Aws::String value)
inline

The runId of the workflow execution to terminate.

Definition at line 148 of file TerminateWorkflowExecutionRequest.h.

◆ WithRunId() [2/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithRunId ( Aws::String &&  value)
inline

The runId of the workflow execution to terminate.

Definition at line 153 of file TerminateWorkflowExecutionRequest.h.

◆ WithRunId() [3/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithRunId ( const char *  value)
inline

The runId of the workflow execution to terminate.

Definition at line 158 of file TerminateWorkflowExecutionRequest.h.

◆ WithWorkflowId() [1/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithWorkflowId ( const Aws::String value)
inline

The workflowId of the workflow execution to terminate.

Definition at line 107 of file TerminateWorkflowExecutionRequest.h.

◆ WithWorkflowId() [2/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithWorkflowId ( Aws::String &&  value)
inline

The workflowId of the workflow execution to terminate.

Definition at line 112 of file TerminateWorkflowExecutionRequest.h.

◆ WithWorkflowId() [3/3]

TerminateWorkflowExecutionRequest& Aws::SWF::Model::TerminateWorkflowExecutionRequest::WithWorkflowId ( const char *  value)
inline

The workflowId of the workflow execution to terminate.

Definition at line 117 of file TerminateWorkflowExecutionRequest.h.

◆ WorkflowIdHasBeenSet()

bool Aws::SWF::Model::TerminateWorkflowExecutionRequest::WorkflowIdHasBeenSet ( ) const
inline

The workflowId of the workflow execution to terminate.

Definition at line 87 of file TerminateWorkflowExecutionRequest.h.


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