io.cloudshiftdev.awscdk.services.stepfunctions.Chain.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation
Kotlin DSL for AWS CDK
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.stepfunctions

import io.cloudshiftdev.awscdk.common.CdkObject
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * A collection of states to chain onto.
 *
 * A Chain has a start and zero or more chainable ends. If there are
 * zero ends, calling next() on the Chain will fail.
 *
 * Example:
 *
 * ```
 * Map map = Map.Builder.create(this, "Map State")
 * .maxConcurrency(1)
 * .itemsPath(JsonPath.stringAt("$.inputForMap"))
 * .itemSelector(Map.of(
 * "item", JsonPath.stringAt("$.Map.Item.Value")))
 * .resultPath("$.mapOutput")
 * .build();
 * // The Map iterator can contain a IChainable, which can be an individual or multiple steps
 * chained together.
 * // Below example is with a Choice and Pass step
 * Choice choice = new Choice(this, "Choice");
 * Condition condition1 = Condition.stringEquals("$.item.status", "SUCCESS");
 * Pass step1 = new Pass(this, "Step1");
 * Pass step2 = new Pass(this, "Step2");
 * Pass finish = new Pass(this, "Finish");
 * Chain definition = choice.when(condition1, step1).otherwise(step2).afterwards().next(finish);
 * map.itemProcessor(definition);
 * ```
 */
public open class Chain(
  cdkObject: software.amazon.awscdk.services.stepfunctions.Chain,
) : CdkObject(cdkObject),
    IChainable {
  /**
   * The chainable end state(s) of this chain.
   */
  public override fun endStates(): List =
      unwrap(this).getEndStates().map(INextable::wrap)

  /**
   * Identify this Chain.
   */
  public override fun id(): String = unwrap(this).getId()

  /**
   * Continue normal execution with the given state.
   *
   * @param next 
   */
  public open fun next(next: IChainable): Chain =
      unwrap(this).next(next.let(IChainable.Companion::unwrap)).let(Chain::wrap)

  /**
   * The start state of this chain.
   */
  public override fun startState(): State = unwrap(this).getStartState().let(State::wrap)

  /**
   * Return a single state that encompasses all states in the chain.
   *
   * This can be used to add error handling to a sequence of states.
   *
   * Be aware that this changes the result of the inner state machine
   * to be an array with the result of the state machine in it. Adjust
   * your paths accordingly. For example, change 'outputPath' to
   * '$[0]'.
   *
   * @param id 
   * @param props
   */
  public open fun toSingleState(id: String): Parallel =
      unwrap(this).toSingleState(id).let(Parallel::wrap)

  /**
   * Return a single state that encompasses all states in the chain.
   *
   * This can be used to add error handling to a sequence of states.
   *
   * Be aware that this changes the result of the inner state machine
   * to be an array with the result of the state machine in it. Adjust
   * your paths accordingly. For example, change 'outputPath' to
   * '$[0]'.
   *
   * @param id 
   * @param props
   */
  public open fun toSingleState(id: String, props: ParallelProps): Parallel =
      unwrap(this).toSingleState(id, props.let(ParallelProps.Companion::unwrap)).let(Parallel::wrap)

  /**
   * Return a single state that encompasses all states in the chain.
   *
   * This can be used to add error handling to a sequence of states.
   *
   * Be aware that this changes the result of the inner state machine
   * to be an array with the result of the state machine in it. Adjust
   * your paths accordingly. For example, change 'outputPath' to
   * '$[0]'.
   *
   * @param id 
   * @param props
   */
  @kotlin.Suppress("INAPPLICABLE_JVM_NAME")
  @JvmName("bfbc6fc4c1263bfdf5b466cb84f72995423df5a217f266edfb800629a41991e5")
  public open fun toSingleState(id: String, props: ParallelProps.Builder.() -> Unit): Parallel =
      toSingleState(id, ParallelProps(props))

  public companion object {
    public fun custom(
      startState: State,
      endStates: List,
      lastAdded: IChainable,
    ): Chain =
        software.amazon.awscdk.services.stepfunctions.Chain.custom(startState.let(State.Companion::unwrap),
        endStates.map(INextable.Companion::unwrap),
        lastAdded.let(IChainable.Companion::unwrap)).let(Chain::wrap)

    public fun sequence(start: IChainable, next: IChainable): Chain =
        software.amazon.awscdk.services.stepfunctions.Chain.sequence(start.let(IChainable.Companion::unwrap),
        next.let(IChainable.Companion::unwrap)).let(Chain::wrap)

    public fun start(state: IChainable): Chain =
        software.amazon.awscdk.services.stepfunctions.Chain.start(state.let(IChainable.Companion::unwrap)).let(Chain::wrap)

    internal fun wrap(cdkObject: software.amazon.awscdk.services.stepfunctions.Chain): Chain =
        Chain(cdkObject)

    internal fun unwrap(wrapped: Chain): software.amazon.awscdk.services.stepfunctions.Chain =
        wrapped.cdkObject as software.amazon.awscdk.services.stepfunctions.Chain
  }
}