Package software.amazon.awscdk.services.stepfunctions

Class FailProps.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.FailProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<FailProps>
Enclosing interface:
FailProps
@Stability(Stable) public static final class FailProps.Builder extends Object implements software.amazon.jsii.Builder<FailProps>
A builder for FailProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • cause

      @Stability(Stable) public FailProps.Builder cause(String cause)
      Sets the value of FailProps.getCause()
      Parameters:
      cause - A description for the cause of the failure.
      Returns:
      this

    • causePath

      @Stability(Stable) public FailProps.Builder causePath(String causePath)
      Sets the value of FailProps.getCausePath()
      Parameters:
      causePath - JsonPath expression to select part of the state to be the cause to this state. You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.
      Returns:
      this

    • error

      @Stability(Stable) public FailProps.Builder error(String error)
      Sets the value of FailProps.getError()
      Parameters:
      error - Error code used to represent this failure.
      Returns:
      this

    • errorPath

      @Stability(Stable) public FailProps.Builder errorPath(String errorPath)
      Sets the value of FailProps.getErrorPath()
      Parameters:
      errorPath - JsonPath expression to select part of the state to be the error to this state. You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.
      Returns:
      this

    • comment

      @Stability(Stable) public FailProps.Builder comment(String comment)
      Sets the value of StateBaseProps.getComment()
      Parameters:
      comment - A comment describing this state.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public FailProps.Builder queryLanguage(QueryLanguage queryLanguage)
      Sets the value of StateBaseProps.getQueryLanguage()
      Parameters:
      queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
      Returns:
      this

    • stateName

      @Stability(Stable) public FailProps.Builder stateName(String stateName)
      Sets the value of StateBaseProps.getStateName()
      Parameters:
      stateName - Optional name for this state.
      Returns:
      this

    • build

      @Stability(Stable) public FailProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<FailProps>
      Returns:
      a new instance of FailProps
      Throws:
      NullPointerException - if any required attribute was not provided