Package software.amazon.awssdk.services.swf.model

Class WorkflowExecutionInfo

java.lang.Object

software.amazon.awssdk.services.swf.model.WorkflowExecutionInfo

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>

@Generated("software.amazon.awssdk:codegen")
public class WorkflowExecutionInfo
extends Object
implements StructuredPojo, ToCopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>

Contains information about a workflow execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowExecutionInfo.Builder

Method Summary

Modifier and Type	Method	Description
static WorkflowExecutionInfo.Builder	builder()
Boolean	cancelRequested()	Set to true if a cancellation is requested for this workflow execution.
String	closeStatus()	If the execution status is closed then this specifies how the execution was closed:
Date	closeTimestamp()	The time when the workflow execution was closed.
boolean	equals(Object obj)
WorkflowExecution	execution()	The workflow execution this information is about.
String	executionStatus()	The current status of the execution.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
WorkflowExecution	parent()	If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
static Class<? extends WorkflowExecutionInfo.Builder>	serializableBuilderClass()
Date	startTimestamp()	The time when the execution was started.
List<String>	tagList()	The list of tags associated with the workflow execution.
WorkflowExecutionInfo.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
WorkflowType	workflowType()	The type of the workflow execution.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

execution

public WorkflowExecution execution()

The workflow execution this information is about.

Returns:

The workflow execution this information is about.

workflowType

public WorkflowType workflowType()

The type of the workflow execution.

Returns:

The type of the workflow execution.

startTimestamp

public Date startTimestamp()

The time when the execution was started.

Returns:

The time when the execution was started.

closeTimestamp

public Date closeTimestamp()

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.

executionStatus

public String executionStatus()

The current status of the execution.

Returns:

The current status of the execution.

See Also:

ExecutionStatus

closeStatus

public 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:

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

parent

public WorkflowExecution parent()

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.

tagList

public List<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:

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.

cancelRequested

public Boolean cancelRequested()

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.

toBuilder

public WorkflowExecutionInfo.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>

Returns:

a builder for type T

builder

public static WorkflowExecutionInfo.Builder builder()

serializableBuilderClass

public static Class<? extends WorkflowExecutionInfo.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.