com.amazonaws.services.simpleworkflow.model

Class WorkflowExecutionInfo

java.lang.Object

com.amazonaws.services.simpleworkflow.model.WorkflowExecutionInfo

All Implemented Interfaces:

Serializable

public class WorkflowExecutionInfo
extends Object
implements Serializable

Contains information about a workflow execution.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkflowExecutionInfo()

Method Summary

Methods

Modifier and Type	Method and Description
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: 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.
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	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: 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.
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.
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; useful for testing and debugging.
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: 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.
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.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkflowExecutionInfo

public WorkflowExecutionInfo()

Method Detail

getExecution

public WorkflowExecution getExecution()

The workflow execution this information is about.

Returns:

The workflow execution this information is about.

setExecution

public void setExecution(WorkflowExecution execution)

The workflow execution this information is about.

Parameters:

execution - The workflow execution this information is about.

withExecution

public WorkflowExecutionInfo withExecution(WorkflowExecution execution)

The workflow execution this information is about.

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

Parameters:

execution - The workflow execution this information is about.

Returns:

A reference to this updated object so that method calls can be chained together.

getWorkflowType

public WorkflowType getWorkflowType()

The type of the workflow execution.

Returns:

The type of the workflow execution.

setWorkflowType

public void setWorkflowType(WorkflowType workflowType)

The type of the workflow execution.

Parameters:

workflowType - The type of the workflow execution.

withWorkflowType

public WorkflowExecutionInfo withWorkflowType(WorkflowType workflowType)

The type of the workflow execution.

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

Parameters:

workflowType - The type of the workflow execution.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartTimestamp

public Date getStartTimestamp()

The time when the execution was started.

Returns:

The time when the execution was started.

setStartTimestamp

public void setStartTimestamp(Date startTimestamp)

The time when the execution was started.

Parameters:

startTimestamp - The time when the execution was started.

withStartTimestamp

public WorkflowExecutionInfo withStartTimestamp(Date startTimestamp)

The time when the execution was started.

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

Parameters:

startTimestamp - The time when the execution was started.

Returns:

A reference to this updated object so that method calls can be chained together.

getCloseTimestamp

public Date 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.

setCloseTimestamp

public void setCloseTimestamp(Date 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.

withCloseTimestamp

public WorkflowExecutionInfo withCloseTimestamp(Date closeTimestamp)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getExecutionStatus

public String getExecutionStatus()

The current status of the execution.

Constraints:
Allowed Values: OPEN, CLOSED

Returns:

The current status of the execution.

See Also:

ExecutionStatus

setExecutionStatus

public void setExecutionStatus(String executionStatus)

The current status of the execution.

Constraints:
Allowed Values: OPEN, CLOSED

Parameters:

executionStatus - The current status of the execution.

See Also:

ExecutionStatus

withExecutionStatus

public WorkflowExecutionInfo withExecutionStatus(String executionStatus)

The current status of the execution.

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

Constraints:
Allowed Values: OPEN, CLOSED

Parameters:

executionStatus - The current status of the execution.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ExecutionStatus

setExecutionStatus

public void setExecutionStatus(ExecutionStatus executionStatus)

The current status of the execution.

Constraints:
Allowed Values: OPEN, CLOSED

Parameters:

executionStatus - The current status of the execution.

See Also:

ExecutionStatus

withExecutionStatus

public WorkflowExecutionInfo withExecutionStatus(ExecutionStatus executionStatus)

The current status of the execution.

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

Constraints:
Allowed Values: OPEN, CLOSED

Parameters:

executionStatus - The current status of the execution.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ExecutionStatus

getCloseStatus

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.

Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT

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:

CloseStatus

setCloseStatus

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.

Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT

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:

CloseStatus

withCloseStatus

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.

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

Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT

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:

A reference to this updated object so that method calls can be chained together.

See Also:

CloseStatus

setCloseStatus

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.

Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT

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:

CloseStatus

withCloseStatus

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.

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

Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT

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:

A reference to this updated object so that method calls can be chained together.

See Also:

CloseStatus

getParent

public WorkflowExecution 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.

setParent

public void setParent(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.

withParent

public WorkflowExecutionInfo withParent(WorkflowExecution parent)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getTagList

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.

Constraints:
Length: 0 - 5

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

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.

Constraints:
Length: 0 - 5

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

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.

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

Constraints:
Length: 0 - 5

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:

A reference to this updated object so that method calls can be chained together.

withTagList

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.

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

Constraints:
Length: 0 - 5

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:

A reference to this updated object so that method calls can be chained together.

isCancelRequested

public Boolean 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.

setCancelRequested

public void setCancelRequested(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.

withCancelRequested

public WorkflowExecutionInfo withCancelRequested(Boolean cancelRequested)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getCancelRequested

public Boolean 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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object