ScheduleState (temporal-sdk 1.23.1 API)

java.lang.Object
- io.temporal.client.schedules.ScheduleState

public final class ScheduleState
extends java.lang.Object

State of a schedule.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ScheduleState.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getNote()`	Gets the human-readable message for the schedule.
`long`	`getRemainingActions()`	Gets the actions remaining on this schedule.
`int`	`hashCode()`
`boolean`	`isLimitedAction()`	Gets a value indicating whether, if true, remaining actions will be decremented for each action taken.
`boolean`	`isPaused()`	Gets a value indicating whether this schedule is paused.
`static ScheduleState.Builder`	`newBuilder()`
`static ScheduleState.Builder`	`newBuilder(ScheduleState options)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - newBuilder
```
public static ScheduleState.Builder newBuilder()
```
  - newBuilder
```
public static ScheduleState.Builder newBuilder(ScheduleState options)
```
  - getNote
```
public java.lang.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(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object