Class TerminateWorkflowExecutionRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.Optional. Details for terminating the workflow execution.The domain of the workflow execution to terminate.Optional. A descriptive reason for terminating the workflow execution.getRunId()
The runId of the workflow execution to terminate.The workflowId of the workflow execution to terminate.int
hashCode()
void
setChildPolicy
(ChildPolicy childPolicy) If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.void
setChildPolicy
(String childPolicy) If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.void
setDetails
(String details) Optional. Details for terminating the workflow execution.void
The domain of the workflow execution to terminate.void
Optional. A descriptive reason for terminating the workflow execution.void
The runId of the workflow execution to terminate.void
setWorkflowId
(String workflowId) The workflowId of the workflow execution to terminate.toString()
Returns a string representation of this object; useful for testing and debugging.withChildPolicy
(ChildPolicy childPolicy) If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.withChildPolicy
(String childPolicy) If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.withDetails
(String details) Optional. Details for terminating the workflow execution.withDomain
(String domain) The domain of the workflow execution to terminate.withReason
(String reason) Optional. A descriptive reason for terminating the workflow execution.The runId of the workflow execution to terminate.withWorkflowId
(String workflowId) The workflowId of the workflow execution to terminate.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
TerminateWorkflowExecutionRequest
public TerminateWorkflowExecutionRequest()
-
-
Method Details
-
setDomain
The domain of the workflow execution to terminate.
- Parameters:
domain
- The domain of the workflow execution to terminate.
-
getDomain
The domain of the workflow execution to terminate.
- Returns:
- The domain of the workflow execution to terminate.
-
withDomain
The domain of the workflow execution to terminate.
- Parameters:
domain
- The domain of the workflow execution to terminate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWorkflowId
The workflowId of the workflow execution to terminate.
- Parameters:
workflowId
- The workflowId of the workflow execution to terminate.
-
getWorkflowId
The workflowId of the workflow execution to terminate.
- Returns:
- The workflowId of the workflow execution to terminate.
-
withWorkflowId
The workflowId of the workflow execution to terminate.
- Parameters:
workflowId
- The workflowId of the workflow execution to terminate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRunId
The runId of the workflow execution to terminate.
- Parameters:
runId
- The runId of the workflow execution to terminate.
-
getRunId
The runId of the workflow execution to terminate.
- Returns:
- The runId of the workflow execution to terminate.
-
withRunId
The runId of the workflow execution to terminate.
- Parameters:
runId
- The runId of the workflow execution to terminate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReason
Optional. A descriptive reason for terminating the workflow execution.
- Parameters:
reason
- Optional.
-
getReason
Optional. A descriptive reason for terminating the workflow execution.
- Returns:
- Optional.
-
withReason
Optional. A descriptive reason for terminating the workflow execution.
- Parameters:
reason
- Optional.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDetails
Optional. Details for terminating the workflow execution.
- Parameters:
details
- Optional.
-
getDetails
Optional. Details for terminating the workflow execution.
- Returns:
- Optional.
-
withDetails
Optional. Details for terminating the workflow execution.
- Parameters:
details
- Optional.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChildPolicy
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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - Parameters:
childPolicy
- 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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - See Also:
-
getChildPolicy
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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - Returns:
- 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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - See Also:
-
withChildPolicy
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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - Parameters:
childPolicy
- 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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setChildPolicy
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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - Parameters:
childPolicy
- 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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - See Also:
-
withChildPolicy
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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - Parameters:
childPolicy
- 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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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 will be returned. - Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-