Interface WorkflowExecutionInfo.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<WorkflowExecutionInfo.Builder,
,WorkflowExecutionInfo> SdkBuilder<WorkflowExecutionInfo.Builder,
,WorkflowExecutionInfo> SdkPojo
- Enclosing class:
WorkflowExecutionInfo
-
Method Summary
Modifier and TypeMethodDescriptioncancelRequested
(Boolean cancelRequested) Set to true if a cancellation is requested for this workflow execution.closeStatus
(String closeStatus) If the execution status is closed then this specifies how the execution was closed:closeStatus
(CloseStatus closeStatus) If the execution status is closed then this specifies how the execution was closed: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.execution
(WorkflowExecution execution) The workflow execution this information is about.executionStatus
(String executionStatus) The current status of the execution.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.parent
(WorkflowExecution parent) If this workflow execution is a child of another execution then contains the workflow execution that started this execution.startTimestamp
(Instant startTimestamp) The time when the execution was started.The list of tags associated with the workflow execution.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.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, sdkFields
-
Method Details
-
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
The workflow execution this information is about.
This is a convenience method that creates an instance of theWorkflowExecution.Builder
avoiding the need to create one manually viaWorkflowExecution.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexecution(WorkflowExecution)
.- Parameters:
execution
- a consumer that will call methods onWorkflowExecution.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The type of the workflow execution.
This is a convenience method that creates an instance of theWorkflowType.Builder
avoiding the need to create one manually viaWorkflowType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkflowType(WorkflowType)
.- Parameters:
workflowType
- a consumer that will call methods onWorkflowType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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:
-
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
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:
-
-
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
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 theWorkflowExecution.Builder
avoiding the need to create one manually viaWorkflowExecution.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparent(WorkflowExecution)
.- Parameters:
parent
- a consumer that will call methods onWorkflowExecution.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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.
-