com.amazonaws.services.stepfunctions.builder.states

Interface ParametersBuilder<BuilderT>

Type Parameters:

BuilderT - Type of concrete builder (for method chaining).

All Known Implementing Classes:

MapState.Builder, ParallelState.Builder, PassState.Builder, TaskState.Builder

public interface ParametersBuilder<BuilderT>

Interface for all builders that expose the 'Parameters' field.

This interface should not be implemented outside the SDK.

Method Summary

Modifier and Type	Method and Description
BuilderT	parameters(Object parameters) OPTIONAL.
BuilderT	parameters(String parameters) OPTIONAL.

Method Detail

parameters

BuilderT parameters(String parameters)

OPTIONAL. The value of "Parameters" MUST be a valid JSON document. This field forms the effective input to the Task if present. Values from the input to the state can be interpolated via a JSON path expression. To be interpolated the field name of the JSON object must end in the suffix ".$". See example below.

Given the following Parameters definition.

 
 {
 ...
   "Parameters": {
      "flagged": true,
      "parts": {
         "first.$": "$.vals[0]",
         "last3.$": "$.vals[3:]"
      }
   }
 ...
 }
 
 

And suppose that the input to the state is as follows:

 
 {
    "flagged": 7,
    "vals": [0, 10, 20, 30, 40, 50]
 }
 
 

Then the effective input to the task will be as follows:

 
 {
    "flagged": true,
    "parts": {
       "first": 0,
       "last3": [30, 40, 50]
    }
 }
 
 

Parameters:

parameters - Raw JSON string representing Parameters value.

Returns:

This object for method chaining.

parameters

BuilderT parameters(Object parameters)

OPTIONAL. The value of "Parameters" MUST be a valid JSON document. This field forms the effective input to the Task if present. Values from the input to the state can be interpolated via a JSON path expression. To be interpolated the field name of the JSON object must end in the suffix ".$". See example below.

Given the following Parameters definition.

 
 {
 ...
   "Parameters": {
      "flagged": true,
      "parts": {
         "first.$": "$.vals[0]",
         "last3.$": "$.vals[3:]"
      }
   }
 ...
 }
 
 

And suppose that the input to the state is as follows:

 
 {
    "flagged": 7,
    "vals": [0, 10, 20, 30, 40, 50]
 }
 
 

Then the effective input to the task will be as follows:

 
 {
    "flagged": true,
    "parts": {
       "first": 0,
       "last3": [30, 40, 50]
    }
 }
 
 

Parameters:

parameters - Object that will be serialized into the JSON document representing this states parameters.

Returns:

This object for method chaining.