ScheduleHandle
in package
FinalYes
Operations bound to a schedule ID.
Table of Contents
Properties
- $scheduleId : string
- $client : Client
Methods
- __construct() : mixed
- backfill() : array<string, mixed>
- delete() : void
- describe() : ScheduleDescription
- history() : array<string, mixed>
- pause() : void
- resume() : void
- trigger() : array<string, mixed>
- update() : void
Properties
$scheduleId read-only
public
string
$scheduleId
$client read-only
private
Client
$client
Methods
__construct()
public
__construct(Client $client, string $scheduleId) : mixed
Parameters
- $client : Client
- $scheduleId : string
backfill()
public
backfill(string $startTime, string $endTime[, string|null $overlapPolicy = null ]) : array<string, mixed>
Parameters
- $startTime : string
- $endTime : string
- $overlapPolicy : string|null = null
Return values
array<string, mixed>delete()
public
delete() : void
describe()
public
describe() : ScheduleDescription
Return values
ScheduleDescriptionhistory()
public
history([int|null $limit = null ][, int|null $afterSequence = null ]) : array<string, mixed>
Parameters
- $limit : int|null = null
- $afterSequence : int|null = null
Return values
array<string, mixed>pause()
public
pause([string|null $note = null ]) : void
Parameters
- $note : string|null = null
resume()
public
resume([string|null $note = null ]) : void
Parameters
- $note : string|null = null
trigger()
public
trigger([string|null $overlapPolicy = null ]) : array<string, mixed>
Parameters
- $overlapPolicy : string|null = null
Return values
array<string, mixed>update()
public
update(array<string, mixed> $changes) : void
Parameters
- $changes : array<string, mixed>