Package software.amazon.awscdk.services.stepfunctions

Class SingleStateOptions.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.SingleStateOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SingleStateOptions>

Enclosing interface:

SingleStateOptions

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

A builder for SingleStateOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SingleStateOptions	build()	Builds the configured instance.
SingleStateOptions.Builder	comment(String comment)	Sets the value of ParallelProps.getComment()
SingleStateOptions.Builder	inputPath(String inputPath)	Sets the value of ParallelProps.getInputPath()
SingleStateOptions.Builder	outputPath(String outputPath)	Sets the value of ParallelProps.getOutputPath()
SingleStateOptions.Builder	prefixStates(String prefixStates)	Sets the value of SingleStateOptions.getPrefixStates()
SingleStateOptions.Builder	resultPath(String resultPath)	Sets the value of ParallelProps.getResultPath()
SingleStateOptions.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of ParallelProps.getResultSelector()
SingleStateOptions.Builder	stateId(String stateId)	Sets the value of SingleStateOptions.getStateId()
SingleStateOptions.Builder	stateName(String stateName)	Sets the value of ParallelProps.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

prefixStates

@Stability(Stable)
public SingleStateOptions.Builder prefixStates(String prefixStates)

Sets the value of SingleStateOptions.getPrefixStates()

Parameters:

prefixStates - String to prefix all stateIds in the state machine with.

Returns:

this

stateId

@Stability(Stable)
public SingleStateOptions.Builder stateId(String stateId)

Sets the value of SingleStateOptions.getStateId()

Parameters:

stateId - ID of newly created containing state.

Returns:

this

comment

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

Sets the value of ParallelProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

inputPath

@Stability(Stable)
public SingleStateOptions.Builder inputPath(String inputPath)

Sets the value of ParallelProps.getInputPath()

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

outputPath

@Stability(Stable)
public SingleStateOptions.Builder outputPath(String outputPath)

Sets the value of ParallelProps.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

resultPath

@Stability(Stable)
public SingleStateOptions.Builder resultPath(String resultPath)

Sets the value of ParallelProps.getResultPath()

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

this

resultSelector

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

Sets the value of ParallelProps.getResultSelector()

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

this

stateName

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

Sets the value of ParallelProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

build

@Stability(Stable)
public SingleStateOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SingleStateOptions

Throws:

NullPointerException - if any required attribute was not provided