Interface TestStateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<TestStateRequest.Builder,TestStateRequest>, SdkBuilder<TestStateRequest.Builder,TestStateRequest>, SdkPojo, SdkRequest.Builder, SfnRequest.Builder
Enclosing class:
TestStateRequest
@Mutable @NotThreadSafe public static interface TestStateRequest.Builder extends SfnRequest.Builder, SdkPojo, CopyableBuilder<TestStateRequest.Builder,TestStateRequest>

  • Method Details

    • definition

      TestStateRequest.Builder definition(String definition)

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

      Parameters:
      definition - The Amazon States Language (ASL) definition of the state or state machine.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      TestStateRequest.Builder roleArn(String roleArn)

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

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • input

      TestStateRequest.Builder input(String input)

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

      Parameters:
      input - A string that contains the JSON input data for the state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inspectionLevel

      TestStateRequest.Builder inspectionLevel(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inspectionLevel

      TestStateRequest.Builder inspectionLevel(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • revealSecrets

      TestStateRequest.Builder revealSecrets(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • variables

      TestStateRequest.Builder variables(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • stateName

      TestStateRequest.Builder stateName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • mock

      TestStateRequest.Builder mock(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • mock

      default TestStateRequest.Builder mock(Consumer<MockInput.Builder> 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.

      This is a convenience method that creates an instance of the MockInput.Builder avoiding the need to create one manually via MockInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mock(MockInput).

      Parameters:
      mock - a consumer that will call methods on MockInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • context

      TestStateRequest.Builder context(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • stateConfiguration

      TestStateRequest.Builder stateConfiguration(TestStateConfiguration stateConfiguration)

      Contains configurations for the state under test.

      Parameters:
      stateConfiguration - Contains configurations for the state under test.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateConfiguration

      default TestStateRequest.Builder stateConfiguration(Consumer<TestStateConfiguration.Builder> stateConfiguration)

      Contains configurations for the state under test.

      This is a convenience method that creates an instance of the TestStateConfiguration.Builder avoiding the need to create one manually via TestStateConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stateConfiguration(TestStateConfiguration).

      Parameters:
      stateConfiguration - a consumer that will call methods on TestStateConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      TestStateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      TestStateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.