WorkflowExecutionInfo (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.swf.model.WorkflowExecutionInfo

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkflowExecutionInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>

Contains information about a workflow execution.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WorkflowExecutionInfo.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WorkflowExecutionInfo.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WorkflowExecutionInfo.Builder`	`builder()`
`Boolean`	`cancelRequested()` Set to true if a cancellation is requested for this workflow execution.
`CloseStatus`	`closeStatus()` If the execution status is closed then this specifies how the execution was closed:
`String`	`closeStatusAsString()` If the execution status is closed then this specifies how the execution was closed:
`Instant`	`closeTimestamp()` The time when the workflow execution was closed.
`boolean`	`equals(Object obj)`
`WorkflowExecution`	`execution()` The workflow execution this information is about.
`ExecutionStatus`	`executionStatus()` The current status of the execution.
`String`	`executionStatusAsString()` The current status of the execution.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`WorkflowExecution`	`parent()` If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkflowExecutionInfo.Builder>`	`serializableBuilderClass()`
`Instant`	`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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- 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 Instant startTimestamp()
```
    The time when the execution was started.
    
    Returns:
    
    The time when the execution was started.
  - closeTimestamp
```
public Instant 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 ExecutionStatus executionStatus()
```
    The current status of the execution.
    
    If the service returns an enum value that is not available in the current SDK version, executionStatus will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStatusAsString().
    
    Returns:
    
    The current status of the execution.
    
    See Also:
    
    ExecutionStatus
  - executionStatusAsString
```
public String executionStatusAsString()
```
    The current status of the execution.
    
    If the service returns an enum value that is not available in the current SDK version, executionStatus will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStatusAsString().
    
    Returns:
    
    The current status of the execution.
    
    See Also:
    
    ExecutionStatus
  - closeStatus
```
public 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.
    If the service returns an enum value that is not available in the current SDK version, closeStatus will return CloseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from closeStatusAsString().
    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
  - closeStatusAsString
```
public String closeStatusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, closeStatus will return CloseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from closeStatusAsString().
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class WorkflowExecutionInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

execution

workflowType

startTimestamp

closeTimestamp

executionStatus

executionStatusAsString

closeStatus

closeStatusAsString

parent

tagList

cancelRequested

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields