software.amazon.awscdk.services.stepfunctions

Class Task.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.Task.Builder

Enclosing class:

Task

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

A fluent builder for Task.

Method Summary

Modifier and Type	Method and Description
Task	build()
Task.Builder	comment(String comment) An optional description for this state.
static Task.Builder	create(Construct scope, String id) EXPERIMENTAL
Task.Builder	inputPath(String inputPath) JSONPath expression to select part of the state to be the input to this state.
Task.Builder	outputPath(String outputPath) JSONPath expression to select part of the state to be the output to this state.
Task.Builder	parameters(Map<String,Object> parameters) Parameters to invoke the task with.
Task.Builder	resultPath(String resultPath) JSONPath expression to indicate where to inject the state's output.
Task.Builder	task(IStepFunctionsTask task) Actual task to be invoked in this workflow.
Task.Builder	timeout(Duration timeout) Maximum run time of this state.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Task.Builder create(Construct scope,
                                                                 String id)

EXPERIMENTAL

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Task.Builder.

task

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

Actual task to be invoked in this workflow.

EXPERIMENTAL

Parameters:

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

Returns:

this

comment

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

An optional description for this state.

Default: No comment

EXPERIMENTAL

Parameters:

comment - An optional description for this state. This parameter is required.

Returns:

this

inputPath

@Stability(value=Experimental)
public Task.Builder inputPath(String 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 {}.

Default: $

EXPERIMENTAL

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.

Returns:

this

outputPath

@Stability(value=Experimental)
public Task.Builder outputPath(String 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 {}.

Default: $

EXPERIMENTAL

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. This parameter is required.

Returns:

this

parameters

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

Default: - Use the parameters implied by the `task` property

EXPERIMENTAL

Parameters:

parameters - Parameters to invoke the task with. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

resultPath

@Stability(value=Experimental)
public Task.Builder resultPath(String 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.

Default: $

EXPERIMENTAL

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.

Returns:

this

timeout

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

Maximum run time of this state.

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

Default: 60

EXPERIMENTAL

Parameters:

timeout - Maximum run time of this state. This parameter is required.

Returns:

this

build

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