BigQuery Data Transfer V1 Client - Class ScheduleOptionsV2 (2.1.0)

Reference documentation and code samples for the BigQuery Data Transfer V1 Client class ScheduleOptionsV2.

V2 options customizing different types of data transfer schedule.

This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

Generated from protobuf message google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2

Namespace

Google \ Cloud \ BigQuery \ DataTransfer \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ time_based_schedule`	`Google\Cloud\BigQuery\DataTransfer\V1\TimeBasedSchedule` Time based transfer schedule options. This is the default schedule option.
`↳ manual_schedule`	`Google\Cloud\BigQuery\DataTransfer\V1\ManualSchedule` Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.
`↳ event_driven_schedule`	`Google\Cloud\BigQuery\DataTransfer\V1\EventDrivenSchedule` Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.

getTimeBasedSchedule

Time based transfer schedule options. This is the default schedule option.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\TimeBasedSchedule\|null`

hasTimeBasedSchedule

setTimeBasedSchedule

Time based transfer schedule options. This is the default schedule option.

Parameter
Name	Description
`var`	`Google\Cloud\BigQuery\DataTransfer\V1\TimeBasedSchedule`

Returns
Type	Description
`$this`

getManualSchedule

Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\ManualSchedule\|null`

hasManualSchedule

setManualSchedule

Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.

Parameter
Name	Description
`var`	`Google\Cloud\BigQuery\DataTransfer\V1\ManualSchedule`

Returns
Type	Description
`$this`

getEventDrivenSchedule

Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\EventDrivenSchedule\|null`

hasEventDrivenSchedule

setEventDrivenSchedule

Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.

Parameter
Name	Description
`var`	`Google\Cloud\BigQuery\DataTransfer\V1\EventDrivenSchedule`

Returns
Type	Description
`$this`

getSchedule

Returns
Type	Description
`string`