software.amazon.awscdk.services.stepfunctions

Class StateProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.StateProps.Builder

Enclosing interface:

StateProps

public static final class StateProps.Builder
extends java.lang.Object

A builder for StateProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StateProps	build() Builds the configured instance.
StateProps.Builder	comment(java.lang.String comment) Sets the value of StateProps.getComment()
StateProps.Builder	inputPath(java.lang.String inputPath) Sets the value of StateProps.getInputPath()
StateProps.Builder	outputPath(java.lang.String outputPath) Sets the value of StateProps.getOutputPath()
StateProps.Builder	parameters(java.util.Map<java.lang.String,? extends java.lang.Object> parameters) Sets the value of StateProps.getParameters()
StateProps.Builder	resultPath(java.lang.String resultPath) Sets the value of StateProps.getResultPath()
StateProps.Builder	resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector) Sets the value of StateProps.getResultSelector()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

comment

public StateProps.Builder comment(java.lang.String comment)

Sets the value of StateProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

inputPath

public StateProps.Builder inputPath(java.lang.String inputPath)

Sets the value of StateProps.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

public StateProps.Builder outputPath(java.lang.String outputPath)

Sets the value of StateProps.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

parameters

public StateProps.Builder parameters(java.util.Map<java.lang.String,? extends java.lang.Object> parameters)

Sets the value of StateProps.getParameters()

Parameters:

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

Returns:

this

resultPath

public StateProps.Builder resultPath(java.lang.String resultPath)

Sets the value of StateProps.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

public StateProps.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)

Sets the value of StateProps.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

build

public StateProps build()

Builds the configured instance.

Returns:

a new instance of StateProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided