Class ScheduleState

java.lang.Object
io.temporal.client.schedules.ScheduleState
public final class ScheduleState extends Object
State of a schedule.

  • Method Details

    • newBuilder

      public static ScheduleState.Builder newBuilder()

    • newBuilder

      public static ScheduleState.Builder newBuilder(ScheduleState options)

    • getNote

      public String getNote()
      Gets the human-readable message for the schedule.
      Returns:
      the schedules note

    • isPaused

      public boolean isPaused()
      Gets a value indicating whether this schedule is paused.
      Returns:
      if the schedule is paused

    • isLimitedAction

      public boolean isLimitedAction()
      Gets a value indicating whether, if true, remaining actions will be decremented for each action taken.
      Returns:
      if the schedule has limited actions

    • getRemainingActions

      public long getRemainingActions()
      Gets the actions remaining on this schedule. Once this number hits 0, no further actions are scheduled automatically.
      Returns:
      the number of remaining actions

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object