SchedulePolicies
in package
uses
CloneWith
Schedule policies.
Tags
Table of Contents
Properties
- $catchupWindow : DateInterval
- Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time.
- $overlapPolicy : ScheduleOverlapPolicy
- Policy for overlaps.
- $pauseOnFailure : bool
- If true, and a Workflow run fails or times out, pause the Schedule.
Methods
- new() : self
- withCatchupWindow() : self
- Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time.
- withOverlapPolicy() : self
- Policy for overlaps.
- withPauseOnFailure() : self
- If true, and a workflow run fails or times out, turn on "paused".
- __construct() : mixed
Properties
$catchupWindow read-only
Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time.
public
DateInterval
$catchupWindow
This value defaults to 60 seconds, and can't be less than 10 seconds.
$overlapPolicy read-only
Policy for overlaps.
public
ScheduleOverlapPolicy
$overlapPolicy
Note that this can be changed after a schedule has taken some actions, and some changes might produce unintuitive results. In general, the later policy overrides the earlier policy.
$pauseOnFailure read-only
If true, and a Workflow run fails or times out, pause the Schedule.
public
bool
$pauseOnFailure
This applies after retry policies: the full chain of retries must fail to trigger a pause here.
Methods
new()
public
static new() : self
Return values
selfwithCatchupWindow()
Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time.
public
withCatchupWindow(DateIntervalValue $interval) : self
This value defaults to 60 seconds, and can't be less than 10 seconds.
Parameters
- $interval : DateIntervalValue
Return values
selfwithOverlapPolicy()
Policy for overlaps.
public
withOverlapPolicy(ScheduleOverlapPolicy $overlapPolicy) : self
Note that this can be changed after a schedule has taken some actions, and some changes might produce unintuitive results. In general, the later policy overrides the earlier policy.
Parameters
- $overlapPolicy : ScheduleOverlapPolicy
Return values
selfwithPauseOnFailure()
If true, and a workflow run fails or times out, turn on "paused".
public
withPauseOnFailure([bool $pauseOnFailure = true ]) : self
This applies after retry policies: the full chain of retries must fail to trigger a pause here.
Parameters
- $pauseOnFailure : bool = true
Return values
self__construct()
private
__construct() : mixed