software.amazon.awssdk.services.swf.model

Class TerminateWorkflowExecutionRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.swf.model.TerminateWorkflowExecutionRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class TerminateWorkflowExecutionRequest
extends AmazonWebServiceRequest
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TerminateWorkflowExecutionRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method and Description
static TerminateWorkflowExecutionRequest.Builder	builder()
String	childPolicy() If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
String	details() Optional. Details for terminating the workflow execution.
String	domain() The domain of the workflow execution to terminate.
boolean	equals(Object obj)
int	hashCode()
String	reason() Optional. 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()
String	toString()
String	workflowId() The workflowId of the workflow execution to terminate.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

domain

public String domain()

The domain of the workflow execution to terminate.

Returns:

The domain of the workflow execution to terminate.

workflowId

public String workflowId()

The workflowId of the workflow execution to terminate.

Returns:

The workflowId of the workflow execution to terminate.

runId

public String runId()

The runId of the workflow execution to terminate.

Returns:

The runId of the workflow execution to terminate.

reason

public String reason()

Optional. A descriptive reason for terminating the workflow execution.

Returns:

Optional.

details

public String details()

Optional. Details for terminating the workflow execution.

Returns:

Optional.

childPolicy

public 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 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:

ChildPolicy

toBuilder

public TerminateWorkflowExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

builder

public static TerminateWorkflowExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends TerminateWorkflowExecutionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object