Class StateExitedEventDetails

java.lang.Object
software.amazon.awssdk.services.sfn.model.StateExitedEventDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StateExitedEventDetails.Builder,StateExitedEventDetails>
@Generated("software.amazon.awssdk:codegen") public final class StateExitedEventDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StateExitedEventDetails.Builder,StateExitedEventDetails>

Contains details about an exit from a state during an execution.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the state.

      A name must not contain:

      • white space

      • brackets < > { } [ ]

      • wildcard characters ? *

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

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

      • surrogates (U+D800-DFFF)

      • invalid characters ( U+10FFFF)

      To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

      Returns:
      The name of the state.

      A name must not contain:

      • white space

      • brackets < > { } [ ]

      • wildcard characters ? *

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

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

      • surrogates (U+D800-DFFF)

      • invalid characters ( U+10FFFF)

      To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    • output

      public final String output()

      The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

      Returns:
      The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    • outputDetails

      public final HistoryEventExecutionDataDetails outputDetails()

      Contains details about the output of an execution history event.

      Returns:
      Contains details about the output of an execution history event.

    • hasAssignedVariables

      public final boolean hasAssignedVariables()
      For responses, this returns true if the service returned a value for the AssignedVariables 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.

    • assignedVariables

      public final Map<String,String> assignedVariables()

      Map of variable name and value as a serialized JSON representation.

      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 hasAssignedVariables() method.

      Returns:
      Map of variable name and value as a serialized JSON representation.

    • assignedVariablesDetails

      public final AssignedVariablesDetails assignedVariablesDetails()

      Provides details about input or output in an execution history event.

      Returns:
      Provides details about input or output in an execution history event.

    • toBuilder

      public StateExitedEventDetails.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<StateExitedEventDetails.Builder,StateExitedEventDetails>
      Returns:
      a builder for type T

    • builder

      public static StateExitedEventDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StateExitedEventDetails.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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