Package akka.javasdk.workflow

Record Class Workflow.PauseSettingsBuilder

Object
Record
akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Enclosing class:
Workflow<S>
public static record Workflow.PauseSettingsBuilder(Duration timeout, Optional<String> reason) extends Record

  • Constructor Details

    • PauseSettingsBuilder

      public PauseSettingsBuilder(Duration timeout)

    • PauseSettingsBuilder

      public PauseSettingsBuilder(Duration timeout, Optional<String> reason)
      Creates an instance of a PauseSettingsBuilder record class.
      Parameters:
      timeout - the value for the timeout record component
      reason - the value for the reason record component

  • Method Details

    • reason

      public Workflow.PauseSettingsBuilder reason(String reason)
      Specify pause reason
      Parameters:
      reason - pause reason

    • timeoutHandler

      public <W> Workflow.PauseSettings timeoutHandler(akka.japi.function.Function<W,Workflow.Effect<akka.Done>> timeoutHandler)
      Configures the handler to be invoked when the pause timeout expires.

      The pause timeout handler is a regular workflow command handler that returns a Workflow.Effect<akka.Done>.

      The handler function should be specified as a Java method reference, e.g. MyWorkflow::pauseTimeoutHandler

    • timeoutHandler

      public <W, I> Workflow.PauseSettings timeoutHandler(akka.japi.function.Function2<W,I,Workflow.Effect<akka.Done>> timeoutHandler, I input)
      Configures the handler to be invoked when the pause timeout expires.

      The pause timeout handler is a regular workflow command handler that returns a Workflow.Effect<akka.Done>.

      The handler function should be specified as a Java method reference, e.g. MyWorkflow::pauseTimeoutHandler

      This overload allows you to pass additional input to the timeout handler, when additional context or data that should be captured at the time of pause configuration.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • timeout

      public Duration timeout()
      Returns the value of the timeout record component.
      Returns:
      the value of the timeout record component

    • reason

      public Optional<String> reason()
      Returns the value of the reason record component.
      Returns:
      the value of the reason record component