public static interface TerminateWorkflowExecutionRequest.Builder extends SwfRequest.Builder, CopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>
Modifier and Type | Method and Description |
---|---|
TerminateWorkflowExecutionRequest.Builder |
childPolicy(ChildPolicy childPolicy)
If set, specifies the policy to use for the child workflow executions of the workflow execution being
terminated.
|
TerminateWorkflowExecutionRequest.Builder |
childPolicy(String childPolicy)
If set, specifies the policy to use for the child workflow executions of the workflow execution being
terminated.
|
TerminateWorkflowExecutionRequest.Builder |
details(String details)
Details for terminating the workflow execution.
|
TerminateWorkflowExecutionRequest.Builder |
domain(String domain)
The domain of the workflow execution to terminate.
|
TerminateWorkflowExecutionRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
TerminateWorkflowExecutionRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
TerminateWorkflowExecutionRequest.Builder |
reason(String reason)
A descriptive reason for terminating the workflow execution.
|
TerminateWorkflowExecutionRequest.Builder |
runId(String runId)
The runId of the workflow execution to terminate.
|
TerminateWorkflowExecutionRequest.Builder |
workflowId(String workflowId)
The workflowId of the workflow execution to terminate.
|
build
overrideConfiguration
copy
applyMutation, build
TerminateWorkflowExecutionRequest.Builder domain(String domain)
The domain of the workflow execution to terminate.
domain
- The domain of the workflow execution to terminate.TerminateWorkflowExecutionRequest.Builder workflowId(String workflowId)
The workflowId of the workflow execution to terminate.
workflowId
- The workflowId of the workflow execution to terminate.TerminateWorkflowExecutionRequest.Builder runId(String runId)
The runId of the workflow execution to terminate.
runId
- The runId of the workflow execution to terminate.TerminateWorkflowExecutionRequest.Builder reason(String reason)
A descriptive reason for terminating the workflow execution.
reason
- A descriptive reason for terminating the workflow execution.TerminateWorkflowExecutionRequest.Builder details(String details)
Details for terminating the workflow execution.
details
- Details for terminating the workflow execution.TerminateWorkflowExecutionRequest.Builder childPolicy(String 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 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.
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 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.
ChildPolicy
,
ChildPolicy
TerminateWorkflowExecutionRequest.Builder childPolicy(ChildPolicy 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 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.
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 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.
ChildPolicy
,
ChildPolicy
TerminateWorkflowExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.TerminateWorkflowExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.