Package software.amazon.awscdk.services.stepfunctions

Class TaskInput

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.stepfunctions.TaskInput
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:58.838Z") @Stability(Stable) 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();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

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

  • Method Summary

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

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • TaskInput

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

    • TaskInput

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

  • Method Details

    • fromJsonPathAt

      @Stability(Stable) @NotNull public static TaskInput fromJsonPathAt(@NotNull 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

      @Stability(Stable) @NotNull public static TaskInput fromObject(@NotNull Map<String,? extends Object> obj)
      Use an object as task input.

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

      Use sfn.JsonPath.DISCARD in place of null for languages that do not support null (i.e. Python).

      Parameters:
      obj - This parameter is required.

    • fromText

      @Stability(Stable) @NotNull public static TaskInput fromText(@NotNull 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

      @Stability(Stable) @NotNull public InputType getType()
      type of task input.

    • getValue

      @Stability(Stable) @NotNull public Object getValue()
      payload for the corresponding input type.

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