WorkflowExecutionInfo (AWS Java SDK :: Services

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)`
`boolean`	`equalsBySdkFields(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()`
`boolean`	`hasTagList()` For responses, this returns true if the service returned a value for the TagList property.
`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()`
`String`	`toString()` Returns a string representation of this object.
`WorkflowType`	`workflowType()` The type of the workflow execution.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - execution
```
public final WorkflowExecution execution()
```
    The workflow execution this information is about.
    
    Returns:
    
    The workflow execution this information is about.
  - workflowType
```
public final WorkflowType workflowType()
```
    The type of the workflow execution.
    
    Returns:
    
    The type of the workflow execution.
  - startTimestamp
```
public final Instant startTimestamp()
```
    The time when the execution was started.
    
    Returns:
    
    The time when the execution was started.
  - closeTimestamp
```
public final 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 final 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 final 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 final 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 final 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 final 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.
  - hasTagList
```
public final boolean hasTagList()
```
    For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tagList
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagList() method.
    
    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 final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkflowExecutionInfo.Builder,WorkflowExecutionInfo>
  - builder
```
public static WorkflowExecutionInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkflowExecutionInfo.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasTagList

tagList

cancelRequested

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields