Google Cloud Game Servers V1 Client - Class Schedule (1.2.6)

Reference documentation and code samples for the Google Cloud Game Servers V1 Client class Schedule.

The schedule of a recurring or one time event. The event's time span is specified by start_time and end_time. If the scheduled event's timespan is larger than the cron_spec + cron_job_duration, the event will be recurring.

If only cron_spec + cron_job_duration are specified, the event is effective starting at the local time specified by cron_spec, and is recurring.

 start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time
cron job: cron spec start time + duration 

Generated from protobuf message google.cloud.gaming.v1.Schedule

Namespace

Google \ Cloud \ Gaming \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ start_time
Google\Protobuf\Timestamp

The start time of the event.

↳ end_time
Google\Protobuf\Timestamp

The end time of the event.

↳ cron_job_duration
Google\Protobuf\Duration

The duration for the cron job event. The duration of the event is effective after the cron job's start time.

↳ cron_spec
string

The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron . Cron spec specifies the local time as defined by the realm.

getStartTime

The start time of the event.

Returns
Type
Description

hasStartTime

clearStartTime

setStartTime

The start time of the event.

Parameter
Name
Description
Returns
Type
Description
$this

getEndTime

The end time of the event.

Returns
Type
Description

hasEndTime

clearEndTime

setEndTime

The end time of the event.

Parameter
Name
Description
Returns
Type
Description
$this

getCronJobDuration

The duration for the cron job event. The duration of the event is effective after the cron job's start time.

Returns
Type
Description

hasCronJobDuration

clearCronJobDuration

setCronJobDuration

The duration for the cron job event. The duration of the event is effective after the cron job's start time.

Parameter
Name
Description
Returns
Type
Description
$this

getCronSpec

The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron . Cron spec specifies the local time as defined by the realm.

Returns
Type
Description
string

setCronSpec

The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron . Cron spec specifies the local time as defined by the realm.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: