Package software.amazon.awscdk.services.stepfunctions

Class JsonataStateProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.JsonataStateProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JsonataStateProps>

Enclosing interface:

JsonataStateProps

@Stability(Stable)
public static final class JsonataStateProps.Builder
extends Object
implements software.amazon.jsii.Builder<JsonataStateProps>

A builder for JsonataStateProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JsonataStateProps.Builder	arguments(Object arguments)	Sets the value of JsonataStateOptions.getArguments()
JsonataStateProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
JsonataStateProps	build()	Builds the configured instance.
JsonataStateProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
JsonataStateProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
JsonataStateProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
JsonataStateProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

comment

@Stability(Stable)
public JsonataStateProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public JsonataStateProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public JsonataStateProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

arguments

@Stability(Stable)
public JsonataStateProps.Builder arguments(Object arguments)

Sets the value of JsonataStateOptions.getArguments()

Parameters:

arguments - Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.

Returns:

this

outputs

@Stability(Stable)
public JsonataStateProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Returns:

this

assign

@Stability(Stable)
public JsonataStateProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

build

@Stability(Stable)
public JsonataStateProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<JsonataStateProps>

Returns:

a new instance of JsonataStateProps

Throws:

NullPointerException - if any required attribute was not provided