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 Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`TestStateRequest.Builder`	`context(String context)`	A JSON string representing a valid Context object for the state under test.
`TestStateRequest.Builder`	`definition(String definition)`	The Amazon States Language (ASL) definition of the state or state machine.
`TestStateRequest.Builder`	`input(String input)`	A string that contains the JSON input data for the state.
`TestStateRequest.Builder`	`inspectionLevel(String inspectionLevel)`	Determines the values to return when a state is tested.
`TestStateRequest.Builder`	`inspectionLevel(InspectionLevel inspectionLevel)`	Determines the values to return when a state is tested.
`default TestStateRequest.Builder`	`mock(Consumer<MockInput.Builder> mock)`	Defines a mocked result or error for the state under test.
`TestStateRequest.Builder`	`mock(MockInput mock)`	Defines a mocked result or error for the state under test.
`TestStateRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`TestStateRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`TestStateRequest.Builder`	`revealSecrets(Boolean revealSecrets)`	Specifies whether or not to include secret information in the test result.
`TestStateRequest.Builder`	`roleArn(String roleArn)`	The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
`default TestStateRequest.Builder`	`stateConfiguration(Consumer<TestStateConfiguration.Builder> stateConfiguration)`	Contains configurations for the state under test.
`TestStateRequest.Builder`	`stateConfiguration(TestStateConfiguration stateConfiguration)`	Contains configurations for the state under test.
`TestStateRequest.Builder`	`stateName(String stateName)`	Denotes the particular state within a state machine definition to be tested.
`TestStateRequest.Builder`	`variables(String variables)`	JSON object literal that sets variables used in the state under test.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.sfn.model.SfnRequest.Builder
build

- Method Detail
  - 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, InspectionLevel
  - 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:
    
    InspectionLevel, InspectionLevel
  - 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:
    
    mock(MockInput)
  - 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:
    
    stateConfiguration(TestStateConfiguration)
  - overrideConfiguration
```
TestStateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
TestStateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface TestStateRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.services.sfn.model.SfnRequest.Builder

Method Detail

definition

roleArn

input

inspectionLevel

inspectionLevel

revealSecrets

variables

stateName

mock

mock

context

stateConfiguration

stateConfiguration

overrideConfiguration

overrideConfiguration