software.amazon.awscdk.services.stepfunctions

Class TaskProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.TaskProps.Builder

Enclosing interface:

TaskProps

@Stability(value=Experimental)
public static final class TaskProps.Builder
extends Object

A builder for TaskProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TaskProps	build() Builds the configured instance.
TaskProps.Builder	comment(String comment) Sets the value of TaskProps.getComment()
TaskProps.Builder	inputPath(String inputPath) Sets the value of TaskProps.getInputPath()
TaskProps.Builder	outputPath(String outputPath) Sets the value of TaskProps.getOutputPath()
TaskProps.Builder	parameters(Map<String,Object> parameters) Sets the value of TaskProps.getParameters()
TaskProps.Builder	resultPath(String resultPath) Sets the value of TaskProps.getResultPath()
TaskProps.Builder	task(IStepFunctionsTask task) Sets the value of TaskProps.getTask()
TaskProps.Builder	timeout(Duration timeout) Sets the value of TaskProps.getTimeout()

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

task

@Stability(value=Experimental)
public TaskProps.Builder task(IStepFunctionsTask task)

Sets the value of TaskProps.getTask()

Parameters:

task - Actual task to be invoked in this workflow. This parameter is required.

Returns:

this

comment

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

Sets the value of TaskProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

inputPath

@Stability(value=Experimental)
public TaskProps.Builder inputPath(String inputPath)

Sets the value of TaskProps.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 TaskProps.Builder outputPath(String outputPath)

Sets the value of TaskProps.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 TaskProps.Builder parameters(Map<String,Object> parameters)

Sets the value of TaskProps.getParameters()

Parameters:

parameters - Parameters to invoke the task with. It is not recommended to use this field. The object that is passed in the task property will take care of returning the right values for the Parameters field in the Step Functions definition.

The various classes that implement IStepFunctionsTask will take a properties which make sense for the task type. For example, for InvokeFunction the field that populates the parameters field will be called payload, and for the PublishToTopic the parameters field will be populated via a combination of the referenced topic, subject and message.

If passed anyway, the keys in this map will override the parameters returned by the task object.

Returns:

this

resultPath

@Stability(value=Experimental)
public TaskProps.Builder resultPath(String resultPath)

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

timeout

@Stability(value=Experimental)
public TaskProps.Builder timeout(Duration timeout)

Sets the value of TaskProps.getTimeout()

Parameters:

timeout - Maximum run time of this state. If the state takes longer than this amount of time to complete, a 'Timeout' error is raised.

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of TaskProps

Throws:

NullPointerException - if any required attribute was not provided