software.amazon.awscdk.services.stepfunctions

Class StateProps.Builder

java.lang.Object

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

Enclosing interface:

StateProps

@Stability(value=Experimental)
public static final class StateProps.Builder
extends 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(String comment) Sets the value of StateProps.getComment()
StateProps.Builder	inputPath(String inputPath) Sets the value of StateProps.getInputPath()
StateProps.Builder	outputPath(String outputPath) Sets the value of StateProps.getOutputPath()
StateProps.Builder	parameters(Map<String,Object> parameters) Sets the value of StateProps.getParameters()
StateProps.Builder	resultPath(String resultPath) Sets the value of StateProps.getResultPath()

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

@Stability(value=Experimental)
public StateProps.Builder comment(String comment)

Sets the value of StateProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

inputPath

@Stability(value=Experimental)
public StateProps.Builder inputPath(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 DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

outputPath

@Stability(value=Experimental)
public StateProps.Builder outputPath(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 DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

parameters

@Stability(value=Experimental)
public StateProps.Builder parameters(Map<String,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

@Stability(value=Experimental)
public StateProps.Builder resultPath(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 DISCARD, which will cause the state's input to become its output.

Returns:

this

build

@Stability(value=Experimental)
public StateProps build()

Builds the configured instance.

Returns:

a new instance of StateProps

Throws:

NullPointerException - if any required attribute was not provided