All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TestStateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  TestStateRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  TestStateRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getDefinition () The Amazon States Language (ASL) definition of the state.
  String	getInput () A string that contains the JSON input data for the state.
  String	getInspectionLevel () Determines the values to return when a state is tested.
  Boolean	getRevealSecrets () Specifies whether or not to include secret information in the test result.
  String	getRoleArn () The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
  int	hashCode ()
  Boolean	isRevealSecrets () Specifies whether or not to include secret information in the test result.
  void	setDefinition (String definition) The Amazon States Language (ASL) definition of the state.
  void	setInput (String input) A string that contains the JSON input data for the state.
  void	setInspectionLevel (String inspectionLevel) Determines the values to return when a state is tested.
  void	setRevealSecrets (Boolean revealSecrets) Specifies whether or not to include secret information in the test result.
  void	setRoleArn (String roleArn) The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
  String	toString () Returns a string representation of this object.
  TestStateRequest	withDefinition (String definition) The Amazon States Language (ASL) definition of the state.
  TestStateRequest	withInput (String input) A string that contains the JSON input data for the state.
  TestStateRequest	withInspectionLevel (InspectionLevel inspectionLevel) Determines the values to return when a state is tested.
  TestStateRequest	withInspectionLevel (String inspectionLevel) Determines the values to return when a state is tested.
  TestStateRequest	withRevealSecrets (Boolean revealSecrets) Specifies whether or not to include secret information in the test result.
  TestStateRequest	withRoleArn (String roleArn) The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • TestStateRequest

    public TestStateRequest()

• Method Detail

  • setDefinition

    public void setDefinition(String definition)

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

    Parameters:

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

  • getDefinition

    public String getDefinition()

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

    Returns:

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

  • withDefinition

    public TestStateRequest withDefinition(String definition)

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

    Parameters:

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

    Returns:

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

  • setRoleArn

    public void setRoleArn(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.

  • getRoleArn

    public String getRoleArn()

    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.

  • withRoleArn

    public TestStateRequest withRoleArn(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.

  • setInput

    public void setInput(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.

  • getInput

    public String getInput()

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

    Returns:

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

  • withInput

    public TestStateRequest withInput(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.

  • setInspectionLevel

    public void setInspectionLevel(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.

    See Also:

    InspectionLevel

  • getInspectionLevel

    public String getInspectionLevel()

    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:

    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:

    InspectionLevel

  • withInspectionLevel

    public TestStateRequest withInspectionLevel(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

  • withInspectionLevel

    public TestStateRequest withInspectionLevel(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

  • setRevealSecrets

    public void setRevealSecrets(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.

  • getRevealSecrets

    public Boolean getRevealSecrets()

    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.

  • withRevealSecrets

    public TestStateRequest withRevealSecrets(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.

  • isRevealSecrets

    public Boolean isRevealSecrets()

    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.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public TestStateRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()