DescribeExecutionResponse (AWS Java SDK :: Services :: AWS Step Functions 2.20.128 API)

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:: SdkPojo, 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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeExecutionResponse.Builder`	`builder()`
`String`	`cause()` The cause string if the state machine execution failed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`error()` The error string if the state machine execution failed.
`String`	`executionArn()` The Amazon Resource Name (ARN) that identifies the execution.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`input()` The string that contains the JSON input data of the execution.
`CloudWatchEventsExecutionDataDetails`	`inputDetails()` Returns the value of the InputDetails property for this object.
`String`	`mapRunArn()` The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
`String`	`name()` The name of the execution.
`String`	`output()` The JSON output data of the execution.
`CloudWatchEventsExecutionDataDetails`	`outputDetails()` Returns the value of the OutputDetails property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeExecutionResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startDate()` The date the execution is started.
`String`	`stateMachineAliasArn()` The Amazon Resource Name (ARN) of the state machine alias associated with the execution.
`String`	`stateMachineArn()` The Amazon Resource Name (ARN) of the executed stated machine.
`String`	`stateMachineVersionArn()` The Amazon Resource Name (ARN) of the state machine version associated with the execution.
`ExecutionStatus`	`status()` The current status of the execution.
`String`	`statusAsString()` The current status of the execution.
`Instant`	`stopDate()` If the execution ended, the date the execution stopped.
`DescribeExecutionResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`traceHeader()` The X-Ray trace header that was passed to the execution.

Methods inherited from class software.amazon.awssdk.services.sfn.model.SfnResponse
responseMetadata

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

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
  - executionArn
```
public final String executionArn()
```
    The Amazon Resource Name (ARN) that identifies the execution.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the execution.
  - stateMachineArn
```
public final 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 final String name()
```
    The name of the execution.
    
    A name must not contain:
    - white space
    - brackets < > { } [ ]
    - wildcard characters ? *
    - special characters " # % \ ^ | ~ ` $ & , ; : /
    - control characters (U+0000-001F, U+007F-009F)
    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
    Returns:
    The name of the execution.
    
    A name must not contain:
    
    white space
    
    brackets < > { } [ ]
    
    wildcard characters ? *
    
    special characters " # % \ ^ | ~ ` $ & , ; : /
    
    control characters (U+0000-001F, U+007F-009F)
    
    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
  - status
```
public final 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 final 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 final Instant startDate()
```
    The date the execution is started.
    
    Returns:
    
    The date the execution is started.
  - stopDate
```
public final Instant stopDate()
```
    If the execution ended, the date the execution stopped.
    
    Returns:
    
    If the execution ended, the date the execution stopped.
  - input
```
public final String input()
```
    The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    Returns:
    
    The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
  - inputDetails
```
public final CloudWatchEventsExecutionDataDetails inputDetails()
```
    Returns the value of the InputDetails property for this object.
    
    Returns:
    
    The value of the InputDetails property for this object.
  - output
```
public final String output()
```
    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    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. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    This field is set only if the execution succeeds. If the execution fails, this field is null.
  - outputDetails
```
public final CloudWatchEventsExecutionDataDetails outputDetails()
```
    Returns the value of the OutputDetails property for this object.
    
    Returns:
    
    The value of the OutputDetails property for this object.
  - traceHeader
```
public final String traceHeader()
```
    The X-Ray trace header that was passed to the execution.
    
    Returns:
    
    The X-Ray trace header that was passed to the execution.
  - mapRunArn
```
public final String mapRunArn()
```
    The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
  - error
```
public final String error()
```
    The error string if the state machine execution failed.
    
    Returns:
    
    The error string if the state machine execution failed.
  - cause
```
public final String cause()
```
    The cause string if the state machine execution failed.
    
    Returns:
    
    The cause string if the state machine execution failed.
  - stateMachineVersionArn
```
public final String stateMachineVersionArn()
```
    The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
    
    If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
    
    If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.
  - stateMachineAliasArn
```
public final String stateMachineAliasArn()
```
    The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.
    
    If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.
    
    If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.
  - toBuilder
```
public DescribeExecutionResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeExecutionResponse.Builder,DescribeExecutionResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeExecutionResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeExecutionResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeExecutionResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.sfn.model.SfnResponse

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

Methods inherited from class java.lang.Object

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

Method Detail

executionArn

stateMachineArn

name

status

statusAsString

startDate

stopDate

input

inputDetails

output

outputDetails

traceHeader

mapRunArn

error

cause

stateMachineVersionArn

stateMachineAliasArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields