Class TestStateRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sfn.model.SfnRequest
software.amazon.awssdk.services.sfn.model.TestStateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<TestStateRequest.Builder,TestStateRequest>
@Generated("software.amazon.awssdk:codegen") public final class TestStateRequest extends SfnRequest implements ToCopyableBuilder<TestStateRequest.Builder,TestStateRequest>

  • Method Details

    • definition

      public final String definition()

      The Amazon States Language (ASL) definition of the state.

      Returns:
      The Amazon States Language (ASL) definition of the state.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

      Returns:
      The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

    • input

      public final String input()

      A string that contains the JSON input data for the state.

      Returns:
      A string that contains the JSON input data for the state.

    • inspectionLevel

      public final InspectionLevel inspectionLevel()

      Determines the values to return when a state is tested. You can specify one of the following types:

      • INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.

      • DEBUG: Shows the final state output along with the input and output data processing result.

      • TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.

      Each of these levels also provide information about the status of the state execution and the next state to transition to.

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

      Returns:
      Determines the values to return when a state is tested. You can specify one of the following types:

      • INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.

      • DEBUG: Shows the final state output along with the input and output data processing result.

      • TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.

      Each of these levels also provide information about the status of the state execution and the next state to transition to.

      See Also:

    • inspectionLevelAsString

      public final String inspectionLevelAsString()

      Determines the values to return when a state is tested. You can specify one of the following types:

      • INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.

      • DEBUG: Shows the final state output along with the input and output data processing result.

      • TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.

      Each of these levels also provide information about the status of the state execution and the next state to transition to.

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

      Returns:
      Determines the values to return when a state is tested. You can specify one of the following types:

      • INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.

      • DEBUG: Shows the final state output along with the input and output data processing result.

      • TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.

      Each of these levels also provide information about the status of the state execution and the next state to transition to.

      See Also:

    • revealSecrets

      public final Boolean revealSecrets()

      Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.

      If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.

      By default, revealSecrets is set to false.

      Returns:
      Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.

      If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.

      By default, revealSecrets is set to false.

    • toBuilder

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

    • builder

      public static TestStateRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.