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

Interface TerminateWorkflowExecutionRequest.Builder

All Superinterfaces:

CopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>, SdkBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

Enclosing class:

TerminateWorkflowExecutionRequest

public static interface TerminateWorkflowExecutionRequest.Builder
extends CopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

Method Summary

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

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

copy

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

apply, build

Method Detail

domain

TerminateWorkflowExecutionRequest.Builder domain(String domain)

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.

workflowId

TerminateWorkflowExecutionRequest.Builder workflowId(String workflowId)

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.

runId

TerminateWorkflowExecutionRequest.Builder runId(String runId)

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.

reason

TerminateWorkflowExecutionRequest.Builder reason(String reason)

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.

details

TerminateWorkflowExecutionRequest.Builder details(String details)

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.

childPolicy

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

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

ChildPolicy