@Generated(value="software.amazon.awssdk:codegen") public final class TerminateWorkflowExecutionRequest extends SwfRequest implements ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
TerminateWorkflowExecutionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static TerminateWorkflowExecutionRequest.Builder |
builder() |
ChildPolicy |
childPolicy()
If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
|
String |
childPolicyAsString()
If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
|
String |
details()
Details for terminating the workflow execution.
|
String |
domain()
The domain of the workflow execution to terminate.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
reason()
A descriptive reason for terminating the workflow execution.
|
String |
runId()
The runId of the workflow execution to terminate.
|
static Class<? extends TerminateWorkflowExecutionRequest.Builder> |
serializableBuilderClass() |
TerminateWorkflowExecutionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
workflowId()
The workflowId of the workflow execution to terminate.
|
overrideConfiguration
copy
public String domain()
The domain of the workflow execution to terminate.
public String workflowId()
The workflowId of the workflow execution to terminate.
public String runId()
The runId of the workflow execution to terminate.
public String reason()
A descriptive reason for terminating the workflow execution.
public String details()
Details for terminating the workflow execution.
public 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.
If the service returns an enum value that is not available in the current SDK version, childPolicy
will
return ChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
childPolicyAsString()
.
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
public String childPolicyAsString()
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.
If the service returns an enum value that is not available in the current SDK version, childPolicy
will
return ChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
childPolicyAsString()
.
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
public TerminateWorkflowExecutionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>
toBuilder
in class SwfRequest
public static TerminateWorkflowExecutionRequest.Builder builder()
public static Class<? extends TerminateWorkflowExecutionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.