Class WorkflowExecutionInfo
- All Implemented Interfaces:
Serializable
,Cloneable
Contains information about a workflow execution.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Set to true if a cancellation is requested for this workflow execution.If the execution status is closed then this specifies how the execution was closed:The time when the workflow execution was closed.The workflow execution this information is about.The current status of the execution.If this workflow execution is a child of another execution then contains the workflow execution that started this execution.The time when the execution was started.The list of tags associated with the workflow execution.The type of the workflow execution.int
hashCode()
Set to true if a cancellation is requested for this workflow execution.void
setCancelRequested
(Boolean cancelRequested) Set to true if a cancellation is requested for this workflow execution.void
setCloseStatus
(CloseStatus closeStatus) If the execution status is closed then this specifies how the execution was closed:void
setCloseStatus
(String closeStatus) If the execution status is closed then this specifies how the execution was closed:void
setCloseTimestamp
(Date closeTimestamp) The time when the workflow execution was closed.void
setExecution
(WorkflowExecution execution) The workflow execution this information is about.void
setExecutionStatus
(ExecutionStatus executionStatus) The current status of the execution.void
setExecutionStatus
(String executionStatus) The current status of the execution.void
setParent
(WorkflowExecution parent) If this workflow execution is a child of another execution then contains the workflow execution that started this execution.void
setStartTimestamp
(Date startTimestamp) The time when the execution was started.void
setTagList
(Collection<String> tagList) The list of tags associated with the workflow execution.void
setWorkflowType
(WorkflowType workflowType) The type of the workflow execution.toString()
Returns a string representation of this object; useful for testing and debugging.withCancelRequested
(Boolean cancelRequested) Set to true if a cancellation is requested for this workflow execution.withCloseStatus
(CloseStatus closeStatus) If the execution status is closed then this specifies how the execution was closed:withCloseStatus
(String closeStatus) If the execution status is closed then this specifies how the execution was closed:withCloseTimestamp
(Date closeTimestamp) The time when the workflow execution was closed.withExecution
(WorkflowExecution execution) The workflow execution this information is about.withExecutionStatus
(ExecutionStatus executionStatus) The current status of the execution.withExecutionStatus
(String executionStatus) The current status of the execution.withParent
(WorkflowExecution parent) If this workflow execution is a child of another execution then contains the workflow execution that started this execution.withStartTimestamp
(Date startTimestamp) The time when the execution was started.withTagList
(String... tagList) The list of tags associated with the workflow execution.withTagList
(Collection<String> tagList) The list of tags associated with the workflow execution.withWorkflowType
(WorkflowType workflowType) The type of the workflow execution.
-
Constructor Details
-
WorkflowExecutionInfo
public WorkflowExecutionInfo()
-
-
Method Details
-
setExecution
The workflow execution this information is about.
- Parameters:
execution
- The workflow execution this information is about.
-
getExecution
The workflow execution this information is about.
- Returns:
- The workflow execution this information is about.
-
withExecution
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.
-
setWorkflowType
The type of the workflow execution.
- Parameters:
workflowType
- The type of the workflow execution.
-
getWorkflowType
The type of the workflow execution.
- Returns:
- The type of the workflow execution.
-
withWorkflowType
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.
-
setStartTimestamp
The time when the execution was started.
- Parameters:
startTimestamp
- The time when the execution was started.
-
getStartTimestamp
The time when the execution was started.
- Returns:
- The time when the execution was started.
-
withStartTimestamp
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.
-
setCloseTimestamp
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.
-
getCloseTimestamp
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
- Returns:
- The time when the workflow execution was closed. Set only if the execution status is CLOSED.
-
withCloseTimestamp
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.
-
setExecutionStatus
The current status of the execution.
- Parameters:
executionStatus
- The current status of the execution.- See Also:
-
getExecutionStatus
The current status of the execution.
- Returns:
- The current status of the execution.
- See Also:
-
withExecutionStatus
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:
-
setExecutionStatus
The current status of the execution.
- Parameters:
executionStatus
- The current status of the execution.- See Also:
-
withExecutionStatus
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:
-
setCloseStatus
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.
-
- See Also:
-
-
getCloseStatus
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:
- 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.
-
- See Also:
-
-
withCloseStatus
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:
-
-
setCloseStatus
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.
-
- See Also:
-
-
withCloseStatus
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:
-
-
setParent
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.
-
getParent
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
- Returns:
- If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
-
withParent
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.
-
getTagList
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:
- 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.
-
setTagList
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.
-
withTagList
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.
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
orwithTagList(java.util.Collection)
if you want to override the existing values.- 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.
-
withTagList
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.
-
setCancelRequested
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.
-
getCancelRequested
Set to true if a cancellation is requested for this workflow execution.
- Returns:
- Set to true if a cancellation is requested for this workflow execution.
-
withCancelRequested
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.
-
isCancelRequested
Set to true if a cancellation is requested for this workflow execution.
- Returns:
- Set to true if a cancellation is requested for this workflow execution.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-