ScheduleOptions
in package
uses
CloneWith
Options for creating a Schedule.
Tags
Table of Contents
Properties
- $backfills : array<int, BackfillPeriod>
- $memo : EncodedCollection
- $namespace : string
- $searchAttributes : EncodedCollection
- $triggerImmediately : bool
Methods
- new() : self
- withAddedBackfill() : self
- Adds a new backfill period to the list.
- withBackfills() : self
- Returns a new instance with the replaced backfill list.
- withMemo() : self
- Optional non-indexed info that will be shown in list schedules.
- withNamespace() : self
- withSearchAttributes() : self
- Optional indexed info that can be used in query of List schedules APIs.
- withTriggerImmediately() : self
- Trigger one Action immediately on creating the Schedule.
- __construct() : mixed
Properties
$backfills read-only
public
array<int, BackfillPeriod>
$backfills
$memo read-only
public
EncodedCollection
$memo
$namespace read-only
public
string
$namespace
$searchAttributes read-only
public
EncodedCollection
$searchAttributes
$triggerImmediately read-only
public
bool
$triggerImmediately
Methods
new()
public
static new() : self
Return values
selfwithAddedBackfill()
Adds a new backfill period to the list.
public
withAddedBackfill(BackfillPeriod $value) : self
Runs though the specified time periods and takes Actions as if that time passed by right now, all at once. The overlap policy can be overridden for the scope of the Schedule Backfill.
Parameters
- $value : BackfillPeriod
Return values
selfwithBackfills()
Returns a new instance with the replaced backfill list.
public
withBackfills(BackfillPeriod ...$values) : self
Runs though the specified time periods and takes Actions as if that time passed by right now, all at once. The overlap policy can be overridden for the scope of the Schedule Backfill.
Parameters
- $values : BackfillPeriod
Return values
selfwithMemo()
Optional non-indexed info that will be shown in list schedules.
public
withMemo(iterable<non-empty-string, mixed>|EncodedCollection $values) : self
Parameters
- $values : iterable<non-empty-string, mixed>|EncodedCollection
Return values
selfwithNamespace()
public
withNamespace(string $namespace) : self
Parameters
- $namespace : string
Return values
selfwithSearchAttributes()
Optional indexed info that can be used in query of List schedules APIs.
public
withSearchAttributes(iterable<non-empty-string, mixed>|EncodedCollection $values) : self
The key and value type must be registered on Temporal server side. Use GetSearchAttributes API to get valid key and corresponding value type. For supported operations on different server versions see .
Parameters
- $values : iterable<non-empty-string, mixed>|EncodedCollection
Return values
selfwithTriggerImmediately()
Trigger one Action immediately on creating the Schedule.
public
withTriggerImmediately(bool $value) : self
Parameters
- $value : bool
Return values
self__construct()
private
__construct() : mixed