Google Cloud OsConfig V1 Client - Class RecurringSchedule (2.0.0)

Reference documentation and code samples for the Google Cloud OsConfig V1 Client class RecurringSchedule.

Sets the time for recurring patch deployments.

Generated from protobuf message google.cloud.osconfig.v1.RecurringSchedule

Namespace

Google \ Cloud \ OsConfig \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ time_zone Google\Type\TimeZone

Required. Defines the time zone that time_of_day is relative to. The rules for daylight saving time are determined by the chosen time zone.
↳ start_time Google\Protobuf\Timestamp

Optional. The time that the recurring schedule becomes effective. Defaults to create_time of the patch deployment.
↳ end_time Google\Protobuf\Timestamp

Optional. The end time at which a recurring patch deployment schedule is no longer active.
↳ time_of_day Google\Type\TimeOfDay

Required. Time of the day to run a recurring deployment.
↳ frequency int

Required. The frequency unit of this recurring schedule.
↳ weekly Google\Cloud\OsConfig\V1\WeeklySchedule

Required. Schedule with weekly executions.
↳ monthly Google\Cloud\OsConfig\V1\MonthlySchedule

Required. Schedule with monthly executions.
↳ last_execute_time Google\Protobuf\Timestamp

Output only. The time the last patch job ran successfully.
↳ next_execute_time Google\Protobuf\Timestamp

Output only. The time the next patch job is scheduled to run.

getTimeZone

Required. Defines the time zone that time_of_day is relative to.

The rules for daylight saving time are determined by the chosen time zone.

Returns
Type Description
Google\Type\TimeZone|null

hasTimeZone

clearTimeZone

setTimeZone

Required. Defines the time zone that time_of_day is relative to.

The rules for daylight saving time are determined by the chosen time zone.

Parameter
Name Description
var Google\Type\TimeZone
Returns
Type Description
$this

getStartTime

Optional. The time that the recurring schedule becomes effective.

Defaults to create_time of the patch deployment.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Optional. The time that the recurring schedule becomes effective.

Defaults to create_time of the patch deployment.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

Optional. The end time at which a recurring patch deployment schedule is no longer active.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Optional. The end time at which a recurring patch deployment schedule is no longer active.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getTimeOfDay

Required. Time of the day to run a recurring deployment.

Returns
Type Description
Google\Type\TimeOfDay|null

hasTimeOfDay

clearTimeOfDay

setTimeOfDay

Required. Time of the day to run a recurring deployment.

Parameter
Name Description
var Google\Type\TimeOfDay
Returns
Type Description
$this

getFrequency

Required. The frequency unit of this recurring schedule.

Returns
Type Description
int

setFrequency

Required. The frequency unit of this recurring schedule.

Parameter
Name Description
var int
Returns
Type Description
$this

getWeekly

Required. Schedule with weekly executions.

Returns
Type Description
Google\Cloud\OsConfig\V1\WeeklySchedule|null

hasWeekly

setWeekly

Required. Schedule with weekly executions.

Parameter
Name Description
var Google\Cloud\OsConfig\V1\WeeklySchedule
Returns
Type Description
$this

getMonthly

Required. Schedule with monthly executions.

Returns
Type Description
Google\Cloud\OsConfig\V1\MonthlySchedule|null

hasMonthly

setMonthly

Required. Schedule with monthly executions.

Parameter
Name Description
var Google\Cloud\OsConfig\V1\MonthlySchedule
Returns
Type Description
$this

getLastExecuteTime

Output only. The time the last patch job ran successfully.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastExecuteTime

clearLastExecuteTime

setLastExecuteTime

Output only. The time the last patch job ran successfully.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getNextExecuteTime

Output only. The time the next patch job is scheduled to run.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasNextExecuteTime

clearNextExecuteTime

setNextExecuteTime

Output only. The time the next patch job is scheduled to run.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getScheduleConfig

Returns
Type Description
string