Package software.amazon.awscdk.services.stepfunctions

Interface CatchProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CatchProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:14.330Z") @Stability(Stable) public interface CatchProps extends software.amazon.jsii.JsiiSerializable
Error handler details.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 CatchProps catchProps = CatchProps.builder()
         .errors(List.of("errors"))
         .resultPath("resultPath")
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CatchProps.Builder
    A builder for CatchProps
    static final class 
    CatchProps.Jsii$Proxy
    An implementation for CatchProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static CatchProps.Builder
    builder()
     
    default List<String>
    getErrors()
    Errors to recover from by going to the given state.
    default String
    getResultPath()
    JSONPath expression to indicate where to inject the error data.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getErrors

      @Stability(Stable) @Nullable default List<String> getErrors()
      Errors to recover from by going to the given state.

      A list of error strings to retry, which can be either predefined errors (for example Errors.NoChoiceMatched) or a self-defined error.

      Default: All errors

    • getResultPath

      @Stability(Stable) @Nullable default String getResultPath()
      JSONPath expression to indicate where to inject the error data.

      May also be the special value JsonPath.DISCARD, which will cause the error data to be discarded.

      Default: $

    • builder

      @Stability(Stable) static CatchProps.Builder builder()
      Returns:
      a CatchProps.Builder of CatchProps