software.amazon.awssdk.services.sfn.model

Class DescribeExecutionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sfn.model.SfnResponse

software.amazon.awssdk.services.sfn.model.DescribeExecutionResponse

All Implemented Interfaces:

ToCopyableBuilder<DescribeExecutionResponse.Builder,DescribeExecutionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeExecutionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeExecutionResponse.Builder	builder()
boolean	equals(Object obj)
String	executionArn() The Amazon Resource Name (ARN) that identifies the 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()
String	input() The string that contains the JSON input data of the execution.
String	name() The name of the execution.
String	output() The JSON output data of the execution.
static Class<? extends DescribeExecutionResponse.Builder>	serializableBuilderClass()
Instant	startDate() The date the execution is started.
String	stateMachineArn() The Amazon Resource Name (ARN) of the executed stated machine.
ExecutionStatus	status() The current status of the execution.
String	statusAsString() The current status of the execution.
Instant	stopDate() If the execution has already ended, the date the execution stopped.
DescribeExecutionResponse.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.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

executionArn

public String executionArn()

The Amazon Resource Name (ARN) that identifies the execution.

Returns:

The Amazon Resource Name (ARN) that identifies the execution.

stateMachineArn

public String stateMachineArn()

The Amazon Resource Name (ARN) of the executed stated machine.

Returns:

The Amazon Resource Name (ARN) of the executed stated machine.

name

public String name()

The name of the execution.

A name must not contain:

• whitespace

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

Returns:

The name of the execution.

A name must not contain:

• whitespace

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

status

public ExecutionStatus status()

The current status of the execution.

If the service returns an enum value that is not available in the current SDK version, status will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the execution.

See Also:

ExecutionStatus

statusAsString

public String statusAsString()

The current status of the execution.

If the service returns an enum value that is not available in the current SDK version, status will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the execution.

See Also:

ExecutionStatus

startDate

public Instant startDate()

The date the execution is started.

Returns:

The date the execution is started.

stopDate

public Instant stopDate()

If the execution has already ended, the date the execution stopped.

Returns:

If the execution has already ended, the date the execution stopped.

input

public String input()

The string that contains the JSON input data of the execution.

Returns:

The string that contains the JSON input data of the execution.

output

public String output()

The JSON output data of the execution.

This field is set only if the execution succeeds. If the execution fails, this field is null.

Returns:

The JSON output data of the execution.

This field is set only if the execution succeeds. If the execution fails, this field is null.

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeExecutionResponse.Builder builder()

serializableBuilderClass

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