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.DescribeStateMachineForExecutionResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeStateMachineForExecutionResponse.Builder,DescribeStateMachineForExecutionResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeStateMachineForExecutionResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeStateMachineForExecutionResponse.Builder`	`builder()`
`String`	`definition()`	The Amazon States Language definition of the state machine.
`EncryptionConfiguration`	`encryptionConfiguration()`	Settings to configure server-side encryption.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasVariableReferences()`	For responses, this returns true if the service returned a value for the VariableReferences property.
`String`	`label()`	A user-defined or an auto-generated string that identifies a `Map` state.
`LoggingConfiguration`	`loggingConfiguration()`	Returns the value of the LoggingConfiguration property for this object.
`String`	`mapRunArn()`	The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution.
`String`	`name()`	The name of the state machine associated with the execution.
`String`	`revisionId()`	The revision identifier for the state machine.
`String`	`roleArn()`	The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeStateMachineForExecutionResponse.Builder>`	`serializableBuilderClass()`
`String`	`stateMachineArn()`	The Amazon Resource Name (ARN) of the state machine associated with the execution.
`DescribeStateMachineForExecutionResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`TracingConfiguration`	`tracingConfiguration()`	Selects whether X-Ray tracing is enabled.
`Instant`	`updateDate()`	The date and time the state machine associated with an execution was updated.
`Map<String,List<String>>`	`variableReferences()`	A map of state name to a list of variables referenced by that state.

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
  - stateMachineArn
```
public final String stateMachineArn()
```
    The Amazon Resource Name (ARN) of the state machine associated with the execution.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the state machine associated with the execution.
  - name
```
public final String name()
```
    The name of the state machine associated with the execution.
    
    Returns:
    
    The name of the state machine associated with the execution.
  - definition
```
public final String definition()
```
    The Amazon States Language definition of the state machine. See Amazon States Language.
    
    Returns:
    
    The Amazon States Language definition of the state machine. See Amazon States Language.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
  - updateDate
```
public final Instant updateDate()
```
    The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
    
    Returns:
    
    The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
  - loggingConfiguration
```
public final LoggingConfiguration loggingConfiguration()
```
    Returns the value of the LoggingConfiguration property for this object.
    
    Returns:
    
    The value of the LoggingConfiguration property for this object.
  - tracingConfiguration
```
public final TracingConfiguration tracingConfiguration()
```
    Selects whether X-Ray tracing is enabled.
    
    Returns:
    
    Selects whether X-Ray tracing is enabled.
  - mapRunArn
```
public final String mapRunArn()
```
    The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
  - label
```
public final String label()
```
    A user-defined or an auto-generated string that identifies a Map state. This ﬁeld is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
    
    Returns:
    
    A user-defined or an auto-generated string that identifies a Map state. This ﬁeld is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
  - revisionId
```
public final String revisionId()
```
    The revision identifier for the state machine. The first revision ID when you create the state machine is null.
    
    Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.
    
    Returns:
    
    The revision identifier for the state machine. The first revision ID when you create the state machine is null.
    
    Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.
  - encryptionConfiguration
```
public final EncryptionConfiguration encryptionConfiguration()
```
    Settings to configure server-side encryption.
    
    Returns:
    
    Settings to configure server-side encryption.
  - hasVariableReferences
```
public final boolean hasVariableReferences()
```
    For responses, this returns true if the service returned a value for the VariableReferences 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.
  - variableReferences
```
public final Map<String,List<String>> variableReferences()
```
    A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.
    
    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 hasVariableReferences() method.
    
    Returns:
    
    A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.
  - toBuilder
```
public DescribeStateMachineForExecutionResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeStateMachineForExecutionResponse.Builder,DescribeStateMachineForExecutionResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeStateMachineForExecutionResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeStateMachineForExecutionResponse.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribeStateMachineForExecutionResponse

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

stateMachineArn

name

definition

roleArn

updateDate

loggingConfiguration

tracingConfiguration

mapRunArn

label

revisionId

encryptionConfiguration

hasVariableReferences

variableReferences

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField