software.amazon.awssdk.services.swf.model

Class DescribeWorkflowExecutionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.swf.model.SwfResponse

software.amazon.awssdk.services.swf.model.DescribeWorkflowExecutionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeWorkflowExecutionResponse.Builder,DescribeWorkflowExecutionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeWorkflowExecutionResponse
extends SwfResponse
implements ToCopyableBuilder<DescribeWorkflowExecutionResponse.Builder,DescribeWorkflowExecutionResponse>

Contains details about a workflow execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeWorkflowExecutionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeWorkflowExecutionResponse.Builder	builder()
boolean	equals(Object obj)
WorkflowExecutionConfiguration	executionConfiguration() The configuration settings for this workflow execution including timeout values, tasklist etc.
WorkflowExecutionInfo	executionInfo() Information about the workflow execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
Instant	latestActivityTaskTimestamp() The time when the last activity task was scheduled for this workflow execution.
String	latestExecutionContext() The latest executionContext provided by the decider for this workflow execution.
WorkflowExecutionOpenCounts	openCounts() The number of tasks for this workflow execution.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeWorkflowExecutionResponse.Builder>	serializableBuilderClass()
DescribeWorkflowExecutionResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.services.swf.model.SwfResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

executionInfo

public WorkflowExecutionInfo executionInfo()

Information about the workflow execution.

Returns:

Information about the workflow execution.

executionConfiguration

public WorkflowExecutionConfiguration executionConfiguration()

The configuration settings for this workflow execution including timeout values, tasklist etc.

Returns:

The configuration settings for this workflow execution including timeout values, tasklist etc.

openCounts

public WorkflowExecutionOpenCounts openCounts()

The number of tasks for this workflow execution. This includes open and closed tasks of all types.

Returns:

The number of tasks for this workflow execution. This includes open and closed tasks of all types.

latestActivityTaskTimestamp

public Instant latestActivityTaskTimestamp()

The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

Returns:

The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

latestExecutionContext

public String latestExecutionContext()

The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

Returns:

The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

toBuilder

public DescribeWorkflowExecutionResponse.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<DescribeWorkflowExecutionResponse.Builder,DescribeWorkflowExecutionResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeWorkflowExecutionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeWorkflowExecutionResponse.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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.