Package software.amazon.awssdk.services.swf.model

Class TerminateWorkflowExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.swf.model.SwfRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class TerminateWorkflowExecutionRequest
extends SwfRequest
implements ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TerminateWorkflowExecutionRequest.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	reason()	A descriptive reason for terminating the workflow execution.
String	runId()	The runId of the workflow execution to terminate.
List<SdkField<?>>	sdkFields()
static Class<? extends TerminateWorkflowExecutionRequest.Builder>	serializableBuilderClass()
TerminateWorkflowExecutionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workflowId()	The workflowId of the workflow execution to terminate.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domain

public final String domain()

The domain of the workflow execution to terminate.

Returns:

The domain of the workflow execution to terminate.

workflowId

public final String workflowId()

The workflowId of the workflow execution to terminate.

Returns:

The workflowId of the workflow execution to terminate.

runId

public final String runId()

The runId of the workflow execution to terminate.

Returns:

The runId of the workflow execution to terminate.

reason

public final String reason()

A descriptive reason for terminating the workflow execution.

Returns:

A descriptive reason for terminating the workflow execution.

details

public final String details()

Details for terminating the workflow execution.

Returns:

Details for terminating the workflow execution.

childPolicy

public final 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().

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 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.

See Also:

ChildPolicy

childPolicyAsString

public final 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().

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 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.

See Also:

ChildPolicy

toBuilder

public TerminateWorkflowExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

Specified by:

toBuilder in class SwfRequest

builder

public static TerminateWorkflowExecutionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo