Class DescribeStateMachineForExecutionResponse

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>

  • Method Details

    • 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 field 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 field 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()
      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<DescribeStateMachineForExecutionResponse.Builder,DescribeStateMachineForExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.