Packages

class WorkflowDef[S] extends AnyRef

Source
AbstractWorkflow.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WorkflowDef
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WorkflowDef(_steps: ArrayBuffer[Step] = ArrayBuffer.empty, _stepConfigs: ArrayBuffer[StepConfig] = ArrayBuffer.empty, uniqueNames: Set[String] = mutable.Set.empty, _workflowTimeout: Option[FiniteDuration] = None, _failoverStepName: Option[String] = None, _failoverStepInput: Option[Any] = None, _failoverMaxRetries: Option[MaxRetries] = None, _stepTimeout: Option[FiniteDuration] = None, _stepRecoverStrategy: Option[RecoverStrategy[_]] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WorkflowDef[S] toany2stringadd[WorkflowDef[S]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WorkflowDef[S], B)
    Implicit
    This member is added by an implicit conversion from WorkflowDef[S] toArrowAssoc[WorkflowDef[S]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addStep(step: Step, recoverStrategy: RecoverStrategy[_]): WorkflowDef[S]

    Add step to workflow definition with a dedicated RecoverStrategy.

    Add step to workflow definition with a dedicated RecoverStrategy. Step name must be unique.

    step

    A workflow step

    recoverStrategy

    A Step recovery strategy

  7. def addStep(step: Step): WorkflowDef[S]

    Add step to workflow definition.

    Add step to workflow definition. Step name must be unique.

    step

    A workflow step

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def defaultStepRecoverStrategy(recoverStrategy: RecoverStrategy[_]): WorkflowDef[S]

    Define a default step recovery strategy.

    Define a default step recovery strategy. Can be overridden with step configuration.

  11. def defaultStepTimeout(timeout: FiniteDuration): WorkflowDef[S]

    Define a default step timeout.

    Define a default step timeout. If not set, a default value of 5 seconds is used. Can be overridden with step configuration.

  12. def ensuring(cond: (WorkflowDef[S]) => Boolean, msg: => Any): WorkflowDef[S]
    Implicit
    This member is added by an implicit conversion from WorkflowDef[S] toEnsuring[WorkflowDef[S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (WorkflowDef[S]) => Boolean): WorkflowDef[S]
    Implicit
    This member is added by an implicit conversion from WorkflowDef[S] toEnsuring[WorkflowDef[S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): WorkflowDef[S]
    Implicit
    This member is added by an implicit conversion from WorkflowDef[S] toEnsuring[WorkflowDef[S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): WorkflowDef[S]
    Implicit
    This member is added by an implicit conversion from WorkflowDef[S] toEnsuring[WorkflowDef[S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def failoverMaxRetries: Option[MaxRetries]
  19. def failoverStepInput: Option[_]
  20. def failoverStepName: Option[String]
  21. def failoverTo[I](stepName: String, stepInput: I, maxRetries: MaxRetries): WorkflowDef[S]

    Define a failover step name after workflow timeout.

    Define a failover step name after workflow timeout. Note that recover strategy for this step can set only the number of max retries.

    stepName

    A failover step name

    stepInput

    A failover step input

    maxRetries

    A recovery strategy for failover step.

  22. def failoverTo(stepName: String, maxRetries: MaxRetries): WorkflowDef[S]

    Define a failover step name after workflow timeout.

    Define a failover step name after workflow timeout. Note that recover strategy for this step can set only the number of max retries.

    stepName

    A failover step name

    maxRetries

    A recovery strategy for failover step.

  23. def findByName(name: String): Option[Step]
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def stepConfigs: List[StepConfig]
  31. def stepRecoverStrategy: Option[RecoverStrategy[_]]
  32. def stepTimeout: Option[FiniteDuration]
  33. def steps: List[Step]
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def timeout(timeout: FiniteDuration): WorkflowDef[S]

    Define a timeout for the duration of the entire workflow.

    Define a timeout for the duration of the entire workflow. When the timeout expires, the workflow is finished and no transitions are allowed.

    timeout

    Timeout duration

  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. def workflowTimeout: Option[FiniteDuration]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WorkflowDef[S] toStringFormat[WorkflowDef[S]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (WorkflowDef[S], B)
    Implicit
    This member is added by an implicit conversion from WorkflowDef[S] toArrowAssoc[WorkflowDef[S]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromWorkflowDef[S] to any2stringadd[WorkflowDef[S]]

Inherited by implicit conversion StringFormat fromWorkflowDef[S] to StringFormat[WorkflowDef[S]]

Inherited by implicit conversion Ensuring fromWorkflowDef[S] to Ensuring[WorkflowDef[S]]

Inherited by implicit conversion ArrowAssoc fromWorkflowDef[S] to ArrowAssoc[WorkflowDef[S]]

Ungrouped