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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ time_based_schedule |
TimeBasedSchedule
Time based transfer schedule options. This is the default schedule option. |
↳ manual_schedule |
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 |
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 |
TimeBasedSchedule|null |
|
hasTimeBasedSchedule
setTimeBasedSchedule
Time based transfer schedule options. This is the default schedule option.
| Parameter | |
|---|---|
| Name | Description |
var |
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 |
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 |
ManualSchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventDrivenSchedule
Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.
| Returns | |
|---|---|
| Type | Description |
EventDrivenSchedule|null |
|
hasEventDrivenSchedule
setEventDrivenSchedule
Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.
| Parameter | |
|---|---|
| Name | Description |
var |
EventDrivenSchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchedule
| Returns | |
|---|---|
| Type | Description |
string |
|