Class TestStateResponse

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.TestStateResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<TestStateResponse.Builder,TestStateResponse>
@Generated("software.amazon.awssdk:codegen") public final class TestStateResponse extends SfnResponse implements ToCopyableBuilder<TestStateResponse.Builder,TestStateResponse>

  • Method Details

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

    • error

      public final String error()

      The error returned when the execution of a state fails.

      Returns:
      The error returned when the execution of a state fails.

    • cause

      public final String cause()

      A detailed explanation of the cause for the error when the execution of a state fails.

      Returns:
      A detailed explanation of the cause for the error when the execution of a state fails.

    • inspectionData

      public final InspectionData inspectionData()

      Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel request parameter specifies which details are returned.

      Returns:
      Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel request parameter specifies which details are returned.

    • nextState

      public final String nextState()

      The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.

      Returns:
      The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.

    • status

      public final TestExecutionStatus status()

      The execution status of the state.

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

      Returns:
      The execution status of the state.
      See Also:

    • statusAsString

      public final String statusAsString()

      The execution status of the state.

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

      Returns:
      The execution status of the state.
      See Also:

    • toBuilder

      public TestStateResponse.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<TestStateResponse.Builder,TestStateResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static TestStateResponse.Builder builder()

    • serializableBuilderClass

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