Package software.amazon.awssdk.services.sfn.model

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 or state machine.

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

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

    • variables

      public final String variables()

      JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.

      Returns:
      JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.

    • stateName

      public final String stateName()

      Denotes the particular state within a state machine definition to be tested. If this field is specified, the definition must contain a fully-formed state machine definition.

      Returns:
      Denotes the particular state within a state machine definition to be tested. If this field is specified, the definition must contain a fully-formed state machine definition.

    • mock

      public final MockInput mock()

      Defines a mocked result or error for the state under test.

      A mock can only be specified for Task, Map, or Parallel states. If it is specified for another state type, an exception will be thrown.

      Returns:
      Defines a mocked result or error for the state under test.

      A mock can only be specified for Task, Map, or Parallel states. If it is specified for another state type, an exception will be thrown.

    • context

      public final String context()

      A JSON string representing a valid Context object for the state under test. This field may only be specified if a mock is specified in the same request.

      Returns:
      A JSON string representing a valid Context object for the state under test. This field may only be specified if a mock is specified in the same request.

    • stateConfiguration

      public final TestStateConfiguration stateConfiguration()

      Contains configurations for the state under test.

      Returns:
      Contains configurations for the state under test.

    • toBuilder

      public TestStateRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<TestStateRequest.Builder,TestStateRequest>
      Specified by:
      toBuilder in class SfnRequest

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

    • 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