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

Interface WorkflowExecutionInfo.Builder

All Superinterfaces:

Buildable, CopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>, SdkBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>, SdkPojo

Enclosing class:

WorkflowExecutionInfo

@Mutable
@NotThreadSafe
public static interface WorkflowExecutionInfo.Builder
extends SdkPojo, CopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>

Method Summary

Modifier and Type	Method	Description
WorkflowExecutionInfo.Builder	cancelRequested(Boolean cancelRequested)	Set to true if a cancellation is requested for this workflow execution.
WorkflowExecutionInfo.Builder	closeStatus(String closeStatus)	If the execution status is closed then this specifies how the execution was closed:
WorkflowExecutionInfo.Builder	closeStatus(CloseStatus closeStatus)	If the execution status is closed then this specifies how the execution was closed:
WorkflowExecutionInfo.Builder	closeTimestamp(Instant closeTimestamp)	The time when the workflow execution was closed.
default WorkflowExecutionInfo.Builder	execution(Consumer<WorkflowExecution.Builder> execution)	The workflow execution this information is about.
WorkflowExecutionInfo.Builder	execution(WorkflowExecution execution)	The workflow execution this information is about.
WorkflowExecutionInfo.Builder	executionStatus(String executionStatus)	The current status of the execution.
WorkflowExecutionInfo.Builder	executionStatus(ExecutionStatus executionStatus)	The current status of the execution.
default WorkflowExecutionInfo.Builder	parent(Consumer<WorkflowExecution.Builder> parent)	If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
WorkflowExecutionInfo.Builder	parent(WorkflowExecution parent)	If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
WorkflowExecutionInfo.Builder	startTimestamp(Instant startTimestamp)	The time when the execution was started.
WorkflowExecutionInfo.Builder	tagList(String... tagList)	The list of tags associated with the workflow execution.
WorkflowExecutionInfo.Builder	tagList(Collection<String> tagList)	The list of tags associated with the workflow execution.
default WorkflowExecutionInfo.Builder	workflowType(Consumer<WorkflowType.Builder> workflowType)	The type of the workflow execution.
WorkflowExecutionInfo.Builder	workflowType(WorkflowType workflowType)	The type of the workflow execution.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

execution

WorkflowExecutionInfo.Builder execution(WorkflowExecution execution)

The workflow execution this information is about.

Parameters:

execution - The workflow execution this information is about.

Returns:

Returns a reference to this object so that method calls can be chained together.

execution

default WorkflowExecutionInfo.Builder execution(Consumer<WorkflowExecution.Builder> execution)

The workflow execution this information is about.

This is a convenience method that creates an instance of the WorkflowExecution.Builder avoiding the need to create one manually via WorkflowExecution.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to execution(WorkflowExecution).

Parameters:

execution - a consumer that will call methods on WorkflowExecution.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

execution(WorkflowExecution)

workflowType

WorkflowExecutionInfo.Builder workflowType(WorkflowType workflowType)

The type of the workflow execution.

Parameters:

workflowType - The type of the workflow execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

workflowType

default WorkflowExecutionInfo.Builder workflowType(Consumer<WorkflowType.Builder> workflowType)

The type of the workflow execution.

This is a convenience method that creates an instance of the WorkflowType.Builder avoiding the need to create one manually via WorkflowType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to workflowType(WorkflowType).

Parameters:

workflowType - a consumer that will call methods on WorkflowType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

workflowType(WorkflowType)

startTimestamp

WorkflowExecutionInfo.Builder startTimestamp(Instant startTimestamp)

The time when the execution was started.

Parameters:

startTimestamp - The time when the execution was started.

Returns:

Returns a reference to this object so that method calls can be chained together.

closeTimestamp

WorkflowExecutionInfo.Builder closeTimestamp(Instant closeTimestamp)

The time when the workflow execution was closed. Set only if the execution status is CLOSED.

Parameters:

closeTimestamp - The time when the workflow execution was closed. Set only if the execution status is CLOSED.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionStatus

WorkflowExecutionInfo.Builder executionStatus(String executionStatus)

The current status of the execution.

Parameters:

executionStatus - The current status of the execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExecutionStatus, ExecutionStatus

executionStatus

WorkflowExecutionInfo.Builder executionStatus(ExecutionStatus executionStatus)

The current status of the execution.

Parameters:

executionStatus - The current status of the execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExecutionStatus, ExecutionStatus

closeStatus

WorkflowExecutionInfo.Builder closeStatus(String closeStatus)

If the execution status is closed then this specifies how the execution was closed:

• COMPLETED – the execution was successfully completed.

• CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

• TERMINATED – the execution was force terminated.

• FAILED – the execution failed to complete.

• TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

• CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

Parameters:

closeStatus - If the execution status is closed then this specifies how the execution was closed:

• COMPLETED – the execution was successfully completed.

• CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

• TERMINATED – the execution was force terminated.

• FAILED – the execution failed to complete.

• TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

• CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CloseStatus, CloseStatus

closeStatus

WorkflowExecutionInfo.Builder closeStatus(CloseStatus closeStatus)

If the execution status is closed then this specifies how the execution was closed:

• COMPLETED – the execution was successfully completed.

• CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

• TERMINATED – the execution was force terminated.

• FAILED – the execution failed to complete.

• TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

• CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

Parameters:

closeStatus - If the execution status is closed then this specifies how the execution was closed:

• COMPLETED – the execution was successfully completed.

• CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

• TERMINATED – the execution was force terminated.

• FAILED – the execution failed to complete.

• TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

• CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CloseStatus, CloseStatus

parent

WorkflowExecutionInfo.Builder parent(WorkflowExecution parent)

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Parameters:

parent - If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

parent

default WorkflowExecutionInfo.Builder parent(Consumer<WorkflowExecution.Builder> parent)

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

This is a convenience method that creates an instance of the WorkflowExecution.Builder avoiding the need to create one manually via WorkflowExecution.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parent(WorkflowExecution).

Parameters:

parent - a consumer that will call methods on WorkflowExecution.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

parent(WorkflowExecution)

tagList

WorkflowExecutionInfo.Builder tagList(Collection<String> tagList)

The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

Parameters:

tagList - The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagList

WorkflowExecutionInfo.Builder tagList(String... tagList)

The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

Parameters:

tagList - The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

cancelRequested

WorkflowExecutionInfo.Builder cancelRequested(Boolean cancelRequested)

Set to true if a cancellation is requested for this workflow execution.

Parameters:

cancelRequested - Set to true if a cancellation is requested for this workflow execution.

Returns:

Returns a reference to this object so that method calls can be chained together.