public static interface WorkflowExecutionInfo.Builder extends CopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>
Modifier and Type | Method and Description |
---|---|
WorkflowExecutionInfo.Builder |
cancelRequested(Boolean cancelRequested)
Set to true if a cancellation is requested for this workflow execution.
|
WorkflowExecutionInfo.Builder |
closeStatus(CloseStatus closeStatus)
If the execution status is closed then this specifies how the execution was closed:
|
WorkflowExecutionInfo.Builder |
closeStatus(String 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(ExecutionStatus executionStatus)
The current status of the execution.
|
WorkflowExecutionInfo.Builder |
executionStatus(String 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(Collection<String> tagList)
The list of tags associated with the workflow execution.
|
WorkflowExecutionInfo.Builder |
tagList(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.
|
copy
apply, build
WorkflowExecutionInfo.Builder execution(WorkflowExecution execution)
The workflow execution this information is about.
execution
- The workflow execution this information is about.default WorkflowExecutionInfo.Builder execution(Consumer<WorkflowExecution.Builder> execution)
The workflow execution this information is about.
This is a convenience that creates an instance of theWorkflowExecution.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)
.execution
- a consumer that will call methods on WorkflowExecution.Builder
execution(WorkflowExecution)
WorkflowExecutionInfo.Builder workflowType(WorkflowType workflowType)
The type of the workflow execution.
workflowType
- The type of the workflow execution.default WorkflowExecutionInfo.Builder workflowType(Consumer<WorkflowType.Builder> workflowType)
The type of the workflow execution.
This is a convenience that creates an instance of theWorkflowType.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)
.workflowType
- a consumer that will call methods on WorkflowType.Builder
workflowType(WorkflowType)
WorkflowExecutionInfo.Builder startTimestamp(Instant startTimestamp)
The time when the execution was started.
startTimestamp
- The time when the execution was started.WorkflowExecutionInfo.Builder closeTimestamp(Instant closeTimestamp)
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
closeTimestamp
- The time when the workflow execution was closed. Set only if the execution status is CLOSED.WorkflowExecutionInfo.Builder executionStatus(String executionStatus)
The current status of the execution.
executionStatus
- The current status of the execution.ExecutionStatus
,
ExecutionStatus
WorkflowExecutionInfo.Builder executionStatus(ExecutionStatus executionStatus)
The current status of the execution.
executionStatus
- The current status of the execution.ExecutionStatus
,
ExecutionStatus
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.
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.
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.
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.
CloseStatus
,
CloseStatus
WorkflowExecutionInfo.Builder parent(WorkflowExecution parent)
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
parent
- If this workflow execution is a child of another execution then contains the workflow execution that
started this 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.
This is a convenience that creates an instance of theWorkflowExecution.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)
.parent
- a consumer that will call methods on WorkflowExecution.Builder
parent(WorkflowExecution)
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.
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.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.
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.WorkflowExecutionInfo.Builder cancelRequested(Boolean cancelRequested)
Set to true if a cancellation is requested for this workflow execution.
cancelRequested
- Set to true if a cancellation is requested for this workflow execution.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.