software.amazon.awscdk.services.stepfunctions

Class TaskInput

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.TaskInput

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:21.136Z")
public class TaskInput
extends software.amazon.jsii.JsiiObject

Type union for task classes that accept multiple types of payload.

Example:

 Function fn;
 LambdaInvoke.Builder.create(this, "Invoke with callback")
         .lambdaFunction(fn)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .payload(TaskInput.fromObject(Map.of(
                 "token", JsonPath.getTaskToken(),
                 "input", JsonPath.stringAt("$.someField"))))
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TaskInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TaskInput(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static TaskInput	fromContextAt(java.lang.String path) Deprecated. Use `fromJsonPathAt`.
static TaskInput	fromDataAt(java.lang.String path) Deprecated. Use `fromJsonPathAt`.
static TaskInput	fromJsonPathAt(java.lang.String path) Use a part of the execution data or task context as task input.
static TaskInput	fromObject(java.util.Map<java.lang.String,? extends java.lang.Object> obj) Use an object as task input.
static TaskInput	fromText(java.lang.String text) Use a literal string as task input.
InputType	getType() type of task input.
java.lang.Object	getValue() payload for the corresponding input type.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskInput

protected TaskInput(software.amazon.jsii.JsiiObjectRef objRef)

TaskInput

protected TaskInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

fromContextAt

@Deprecated
public static TaskInput fromContextAt(java.lang.String path)

Deprecated. Use `fromJsonPathAt`.

(deprecated) Use a part of the task context as task input.

Use this when you want to use a subobject or string from the current task context as complete payload to a task.

Parameters:

path - This parameter is required.

fromDataAt

@Deprecated
public static TaskInput fromDataAt(java.lang.String path)

Deprecated. Use `fromJsonPathAt`.

(deprecated) Use a part of the execution data as task input.

Use this when you want to use a subobject or string from the current state machine execution as complete payload to a task.

Parameters:

path - This parameter is required.

fromJsonPathAt

public static TaskInput fromJsonPathAt(java.lang.String path)

Use a part of the execution data or task context as task input.

Use this when you want to use a subobject or string from the current state machine execution or the current task context as complete payload to a task.

Parameters:

path - This parameter is required.

fromObject

public static TaskInput fromObject(java.util.Map<java.lang.String,? extends java.lang.Object> obj)

Use an object as task input.

This object may contain JSON path fields as object values, if desired.

Parameters:

obj - This parameter is required.

fromText

public static TaskInput fromText(java.lang.String text)

Use a literal string as task input.

This might be a JSON-encoded object, or just a text.

Parameters:

text - This parameter is required.

getType

public InputType getType()

type of task input.

getValue

public java.lang.Object getValue()

payload for the corresponding input type.

It can be a JSON-encoded object, context, data, etc.