ScheduleClient
in package
implements
ScheduleClientInterface
uses
ClientContextTrait
FinalYes
Table of Contents
Interfaces
Properties
- $clientOptions : ClientOptions
- $converter : DataConverterInterface
- $marshaller : MarshallerInterface
- $protoConverter : ProtoToArrayConverter
Methods
- __construct() : mixed
- create() : ScheduleClientInterface
- createSchedule() : ScheduleHandle
- Create a schedule and return its handle.
- getHandle() : ScheduleHandle
- Get a schedule handle to interact with an existing schedule.
- listSchedules() : Paginator<string|int, ScheduleListEntry>
- List all schedules in a namespace.
Properties
$clientOptions
private
ClientOptions
$clientOptions
$converter
private
DataConverterInterface
$converter
$marshaller
private
MarshallerInterface
$marshaller
$protoConverter
private
ProtoToArrayConverter
$protoConverter
Methods
__construct()
public
__construct(ServiceClientInterface $serviceClient[, ClientOptions|null $options = null ][, DataConverterInterface|null $converter = null ]) : mixed
Parameters
- $serviceClient : ServiceClientInterface
- $options : ClientOptions|null = null
- $converter : DataConverterInterface|null = null
create()
public
static create(ServiceClientInterface $serviceClient[, ClientOptions|null $options = null ][, DataConverterInterface|null $converter = null ]) : ScheduleClientInterface
Parameters
- $serviceClient : ServiceClientInterface
- $options : ClientOptions|null = null
- $converter : DataConverterInterface|null = null
Return values
ScheduleClientInterfacecreateSchedule()
Create a schedule and return its handle.
public
createSchedule(Schedule $schedule[, ScheduleOptions|null $options = null ][, string|null $scheduleId = null ]) : ScheduleHandle
Parameters
- $schedule : Schedule
-
Schedule to create.
- $options : ScheduleOptions|null = null
-
Options for creating the schedule.
- $scheduleId : string|null = null
-
Unique ID for the schedule. Will be generated as UUID if not provided.
Return values
ScheduleHandlegetHandle()
Get a schedule handle to interact with an existing schedule.
public
getHandle(string $scheduleID[, string|null $namespace = null ]) : ScheduleHandle
Parameters
- $scheduleID : string
- $namespace : string|null = null
-
If null, the preconfigured namespace will be used.
Return values
ScheduleHandlelistSchedules()
List all schedules in a namespace.
public
listSchedules([string|null $namespace = null ][, int $pageSize = 0 ]) : Paginator<string|int, ScheduleListEntry>
Parameters
- $namespace : string|null = null
-
If null, the preconfigured namespace will be used.
- $pageSize : int = 0
-
Maximum number of Schedule info per page.