temporalio.client.ScheduleState

temporalio.client.ScheduleState

class documentation

class ScheduleState: (source)

Constructor: ScheduleState._from_proto(state)

View In Hierarchy

State of a schedule.

limited_actions: bool = (source)

If true, remaining actions will be decremented for each action taken.

On schedule create, this must be set to true if remaining_actions is non-zero and left false if remaining_actions is zero.

note: str | None = (source)

Human readable message for the schedule.

The system may overwrite this value on certain conditions like pause-on-failure.

paused: bool = (source)

Whether the schedule is paused.

remaining_actions: int = (source)

Actions remaining on this schedule.

Once this number hits 0, no further actions are scheduled automatically.

def _from_proto(state: temporalio.api.schedule.v1.ScheduleState) -> ScheduleState: (source)

Undocumented

def _to_proto(self) -> temporalio.api.schedule.v1.ScheduleState: (source)

Undocumented