Documentation

ScheduleClientInterface extends ClientContextInterface
in

Table of Contents

Methods

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.
withDeadline()  : static
Set the deadline for any service requests
withMetadata()  : static
A metadata map to send to the server
withRetryOptions()  : static
withTimeout()  : static
All the service client calls will be made with the specified timeout.

Methods

createSchedule()

Create a schedule and return its handle.

public createSchedule(Schedule $schedule[, ScheduleOptions|null $options = null ][, non-empty-string|null $scheduleId = null ]) : ScheduleHandle
Parameters
$schedule : Schedule

Schedule to create.

$options : ScheduleOptions|null = null

Options for creating the schedule.

$scheduleId : non-empty-string|null = null

Unique ID for the schedule. Will be generated as UUID if not provided.

Return values
ScheduleHandle

getHandle()

Get a schedule handle to interact with an existing schedule.

public getHandle(non-empty-string $scheduleID[, non-empty-string|null $namespace = null ]) : ScheduleHandle
Parameters
$scheduleID : non-empty-string
$namespace : non-empty-string|null = null

If null, the preconfigured namespace will be used.

Return values
ScheduleHandle

listSchedules()

List all schedules in a namespace.

public listSchedules([non-empty-string|null $namespace = null ][, int<0, max> $pageSize = 0 ]) : Paginator<string|int, ScheduleListEntry>
Parameters
$namespace : non-empty-string|null = null

If null, the preconfigured namespace will be used.

$pageSize : int<0, max> = 0

Maximum number of Schedule info per page.

Return values
Paginator<string|int, ScheduleListEntry>

withDeadline()

Set the deadline for any service requests

public withDeadline(DateTimeInterface $deadline) : static
Parameters
$deadline : DateTimeInterface
Return values
static

withMetadata()

A metadata map to send to the server

public withMetadata(array<string, array<string|int, string>> $metadata) : static
Parameters
$metadata : array<string, array<string|int, string>>
Return values
static

withTimeout()

All the service client calls will be made with the specified timeout.

public withTimeout(float $timeout) : static
Parameters
$timeout : float

in seconds

Return values
static 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results