ScheduleState
in package
uses
CloneWith
ScheduleState describes the current state of a Schedule.
Tags
Table of Contents
Properties
- $limitedActions : bool
- Indicates if limited actions are enabled.
- $notes : string
- Informative human-readable message with contextual notes, e.g. the reason a schedule is paused. The system may overwrite this message on certain conditions, e.g. when pause-on-failure happens.
- $paused : bool
- If true, do not take any actions based on the schedule spec.
- $remainingActions : int
- The Actions remaining in this Schedule. Once this number hits 0, no further Actions are taken.
Methods
- new() : self
- withLimitedActions() : self
- Set whether limited actions are enabled.
- withNotes() : self
- Informative human-readable message with contextual notes, e.g. the reason a schedule is paused. The system may overwrite this message on certain conditions, e.g. when pause-on-failure happens.
- withPaused() : self
- If true, do not take any actions based on the schedule spec.
- withRemainingActions() : self
- The Actions remaining in this Schedule. Once this number hits 0, no further Actions are taken.
- __construct() : mixed
Properties
$limitedActions read-only
Indicates if limited actions are enabled.
public
bool
$limitedActions
If self::$limitedActions is true, decrement self::$remainingActions after each action, and do not take any more scheduled actions if self::$remainingActions is zero. Actions may still be taken by explicit request (i.e. trigger immediately or backfill). Skipped actions (due to overlap policy) do not count against remaining actions.
$notes read-only
Informative human-readable message with contextual notes, e.g. the reason a schedule is paused. The system may overwrite this message on certain conditions, e.g. when pause-on-failure happens.
public
string
$notes
$paused read-only
If true, do not take any actions based on the schedule spec.
public
bool
$paused
$remainingActions read-only
The Actions remaining in this Schedule. Once this number hits 0, no further Actions are taken.
public
int
$remainingActions
Methods
new()
public
static new() : self
Return values
selfwithLimitedActions()
Set whether limited actions are enabled.
public
withLimitedActions(bool $limitedActions) : self
If self::$limitedActions is true, decrement self::$remainingActions after each action, and do not take any more scheduled actions if self::$remainingActions is zero. Actions may still be taken by explicit request (i.e. trigger immediately or backfill). Skipped actions (due to overlap policy) do not count against remaining actions.
Parameters
- $limitedActions : bool
Return values
selfwithNotes()
Informative human-readable message with contextual notes, e.g. the reason a schedule is paused. The system may overwrite this message on certain conditions, e.g. when pause-on-failure happens.
public
withNotes(string $notes) : self
Parameters
- $notes : string
Return values
selfwithPaused()
If true, do not take any actions based on the schedule spec.
public
withPaused(bool $paused) : self
Parameters
- $paused : bool
Return values
selfwithRemainingActions()
The Actions remaining in this Schedule. Once this number hits 0, no further Actions are taken.
public
withRemainingActions(int $remainingActions) : self
Parameters
- $remainingActions : int
Return values
self__construct()
private
__construct() : mixed