@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class WorkflowExecutionInfo extends Object implements Serializable, Cloneable, StructuredPojo
Contains information about a workflow execution.
Constructor and Description |
---|
WorkflowExecutionInfo() |
Modifier and Type | Method and Description |
---|---|
WorkflowExecutionInfo |
clone() |
boolean |
equals(Object obj) |
Boolean |
getCancelRequested()
Set to true if a cancellation is requested for this workflow execution.
|
String |
getCloseStatus()
If the execution status is closed then this specifies how the execution was closed:
|
Date |
getCloseTimestamp()
The time when the workflow execution was closed.
|
WorkflowExecution |
getExecution()
The workflow execution this information is about.
|
String |
getExecutionStatus()
The current status of the execution.
|
WorkflowExecution |
getParent()
If this workflow execution is a child of another execution then contains the workflow execution that started this
execution.
|
Date |
getStartTimestamp()
The time when the execution was started.
|
List<String> |
getTagList()
The list of tags associated with the workflow execution.
|
WorkflowType |
getWorkflowType()
The type of the workflow execution.
|
int |
hashCode() |
Boolean |
isCancelRequested()
Set to true if a cancellation is requested for this workflow execution.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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.
|
String |
toString()
Returns a string representation of this object.
|
WorkflowExecutionInfo |
withCancelRequested(Boolean cancelRequested)
Set to true if a cancellation is requested for this workflow execution.
|
WorkflowExecutionInfo |
withCloseStatus(CloseStatus closeStatus)
If the execution status is closed then this specifies how the execution was closed:
|
WorkflowExecutionInfo |
withCloseStatus(String closeStatus)
If the execution status is closed then this specifies how the execution was closed:
|
WorkflowExecutionInfo |
withCloseTimestamp(Date closeTimestamp)
The time when the workflow execution was closed.
|
WorkflowExecutionInfo |
withExecution(WorkflowExecution execution)
The workflow execution this information is about.
|
WorkflowExecutionInfo |
withExecutionStatus(ExecutionStatus executionStatus)
The current status of the execution.
|
WorkflowExecutionInfo |
withExecutionStatus(String executionStatus)
The current status of the execution.
|
WorkflowExecutionInfo |
withParent(WorkflowExecution parent)
If this workflow execution is a child of another execution then contains the workflow execution that started this
execution.
|
WorkflowExecutionInfo |
withStartTimestamp(Date startTimestamp)
The time when the execution was started.
|
WorkflowExecutionInfo |
withTagList(Collection<String> tagList)
The list of tags associated with the workflow execution.
|
WorkflowExecutionInfo |
withTagList(String... tagList)
The list of tags associated with the workflow execution.
|
WorkflowExecutionInfo |
withWorkflowType(WorkflowType workflowType)
The type of the workflow execution.
|
public void setExecution(WorkflowExecution execution)
The workflow execution this information is about.
execution
- The workflow execution this information is about.public WorkflowExecution getExecution()
The workflow execution this information is about.
public WorkflowExecutionInfo withExecution(WorkflowExecution execution)
The workflow execution this information is about.
execution
- The workflow execution this information is about.public void setWorkflowType(WorkflowType workflowType)
The type of the workflow execution.
workflowType
- The type of the workflow execution.public WorkflowType getWorkflowType()
The type of the workflow execution.
public WorkflowExecutionInfo withWorkflowType(WorkflowType workflowType)
The type of the workflow execution.
workflowType
- The type of the workflow execution.public void setStartTimestamp(Date startTimestamp)
The time when the execution was started.
startTimestamp
- The time when the execution was started.public Date getStartTimestamp()
The time when the execution was started.
public WorkflowExecutionInfo withStartTimestamp(Date startTimestamp)
The time when the execution was started.
startTimestamp
- The time when the execution was started.public void setCloseTimestamp(Date 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.public Date getCloseTimestamp()
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
public WorkflowExecutionInfo withCloseTimestamp(Date 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.public void setExecutionStatus(String executionStatus)
The current status of the execution.
executionStatus
- The current status of the execution.ExecutionStatus
public String getExecutionStatus()
The current status of the execution.
ExecutionStatus
public WorkflowExecutionInfo withExecutionStatus(String executionStatus)
The current status of the execution.
executionStatus
- The current status of the execution.ExecutionStatus
public void setExecutionStatus(ExecutionStatus executionStatus)
The current status of the execution.
executionStatus
- The current status of the execution.ExecutionStatus
public WorkflowExecutionInfo withExecutionStatus(ExecutionStatus executionStatus)
The current status of the execution.
executionStatus
- The current status of the execution.ExecutionStatus
public void setCloseStatus(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
public String 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.
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
public WorkflowExecutionInfo withCloseStatus(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
public void setCloseStatus(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
public WorkflowExecutionInfo withCloseStatus(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
public void setParent(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.public WorkflowExecution getParent()
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
public WorkflowExecutionInfo withParent(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.public List<String> 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.
public void setTagList(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.public WorkflowExecutionInfo withTagList(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.
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
or withTagList(java.util.Collection)
if you want to override
the existing values.
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.public WorkflowExecutionInfo withTagList(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.public void setCancelRequested(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.public Boolean getCancelRequested()
Set to true if a cancellation is requested for this workflow execution.
public WorkflowExecutionInfo withCancelRequested(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.public Boolean isCancelRequested()
Set to true if a cancellation is requested for this workflow execution.
public String toString()
toString
in class Object
Object.toString()
public WorkflowExecutionInfo clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.