Package software.amazon.awscdk.services.stepfunctions

Class TaskStateBaseProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TaskStateBaseProps>

Enclosing interface:

TaskStateBaseProps

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

A builder for TaskStateBaseProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TaskStateBaseProps	build()	Builds the configured instance.
TaskStateBaseProps.Builder	comment(String comment)	Sets the value of TaskStateBaseProps.getComment()
TaskStateBaseProps.Builder	heartbeat(Duration heartbeat)	Sets the value of TaskStateBaseProps.getHeartbeat()
TaskStateBaseProps.Builder	inputPath(String inputPath)	Sets the value of TaskStateBaseProps.getInputPath()
TaskStateBaseProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseProps.getIntegrationPattern()
TaskStateBaseProps.Builder	outputPath(String outputPath)	Sets the value of TaskStateBaseProps.getOutputPath()
TaskStateBaseProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
TaskStateBaseProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
TaskStateBaseProps.Builder	timeout(Duration timeout)	Sets the value of TaskStateBaseProps.getTimeout()

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 TaskStateBaseProps.Builder comment(String comment)

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

heartbeat

@Stability(Stable)
public TaskStateBaseProps.Builder heartbeat(Duration heartbeat)

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

inputPath

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

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

integrationPattern

@Stability(Stable)
public TaskStateBaseProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseProps.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns

Returns:

this

outputPath

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

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

outputPath - JSONPath expression to select select a portion of the state output to pass to the next 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 TaskStateBaseProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.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 TaskStateBaseProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

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

timeout

@Stability(Stable)
public TaskStateBaseProps.Builder timeout(Duration timeout)

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the state machine.

Returns:

this

build

@Stability(Stable)
public TaskStateBaseProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TaskStateBaseProps

Throws:

NullPointerException - if any required attribute was not provided