Reference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::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.
Note: The following fields are mutually exclusive: event_driven_schedule, time_based_schedule, manual_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: event_driven_schedule, time_based_schedule, manual_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: event_driven_schedule, time_based_schedule, manual_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
(::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.
Note: The following fields are mutually exclusive: manual_schedule, time_based_schedule, event_driven_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
value (::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.
Note: The following fields are mutually exclusive: manual_schedule, time_based_schedule, event_driven_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::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.
Note: The following fields are mutually exclusive: manual_schedule, time_based_schedule, event_driven_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: time_based_schedule, manual_schedule, event_driven_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: time_based_schedule, manual_schedule, event_driven_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: time_based_schedule, manual_schedule, event_driven_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# BigQuery Data Transfer Service V1 API - Class Google::Cloud::Bigquery::DataTransfer::V1::ScheduleOptionsV2 (v1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/latest/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [1.4.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.4.0/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [1.3.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.3.1/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [1.2.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.2.0/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [1.1.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.1.0/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [1.0.3](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.0.3/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.14.2](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.14.2/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.13.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.13.1/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.12.2](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.12.2/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.11.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.11.0/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.10.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.10.0/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.9.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.9.0/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.8.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.8.0/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.7.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.7.1/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.6.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.6.1/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.5.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.5.1/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2)\n- [0.4.6](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.4.6/Google-Cloud-Bigquery-DataTransfer-V1-ScheduleOptionsV2) \nReference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::ScheduleOptionsV2.\n\nV2 options customizing different types of data transfer schedule.\nThis field supports existing time-based and manual transfer schedule. Also\nsupports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used\ntogether with ScheduleOptions/Schedule. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #event_driven_schedule\n\n def event_driven_schedule() -\u003e ::Google::Cloud::Bigquery::DataTransfer::V1::EventDrivenSchedule\n\n**Returns**\n\n- ([::Google::Cloud::Bigquery::DataTransfer::V1::EventDrivenSchedule](./Google-Cloud-Bigquery-DataTransfer-V1-EventDrivenSchedule)) --- Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.\n\n\n Note: The following fields are mutually exclusive: `event_driven_schedule`, `time_based_schedule`, `manual_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #event_driven_schedule=\n\n def event_driven_schedule=(value) -\u003e ::Google::Cloud::Bigquery::DataTransfer::V1::EventDrivenSchedule\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Bigquery::DataTransfer::V1::EventDrivenSchedule](./Google-Cloud-Bigquery-DataTransfer-V1-EventDrivenSchedule)) --- Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.\n\n\nNote: The following fields are mutually exclusive: `event_driven_schedule`, `time_based_schedule`, `manual_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Bigquery::DataTransfer::V1::EventDrivenSchedule](./Google-Cloud-Bigquery-DataTransfer-V1-EventDrivenSchedule)) --- Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.\n\n\n Note: The following fields are mutually exclusive: `event_driven_schedule`, `time_based_schedule`, `manual_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #manual_schedule\n\n def manual_schedule() -\u003e ::Google::Cloud::Bigquery::DataTransfer::V1::ManualSchedule\n\n**Returns**\n\n- ([::Google::Cloud::Bigquery::DataTransfer::V1::ManualSchedule](./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.\n\n\n Note: The following fields are mutually exclusive: `manual_schedule`, `time_based_schedule`, `event_driven_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #manual_schedule=\n\n def manual_schedule=(value) -\u003e ::Google::Cloud::Bigquery::DataTransfer::V1::ManualSchedule\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Bigquery::DataTransfer::V1::ManualSchedule](./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.\n\n\nNote: The following fields are mutually exclusive: `manual_schedule`, `time_based_schedule`, `event_driven_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Bigquery::DataTransfer::V1::ManualSchedule](./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.\n\n\n Note: The following fields are mutually exclusive: `manual_schedule`, `time_based_schedule`, `event_driven_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #time_based_schedule\n\n def time_based_schedule() -\u003e ::Google::Cloud::Bigquery::DataTransfer::V1::TimeBasedSchedule\n\n**Returns**\n\n- ([::Google::Cloud::Bigquery::DataTransfer::V1::TimeBasedSchedule](./Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)) --- Time based transfer schedule options. This is the default schedule option.\n\n\n Note: The following fields are mutually exclusive: `time_based_schedule`, `manual_schedule`, `event_driven_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #time_based_schedule=\n\n def time_based_schedule=(value) -\u003e ::Google::Cloud::Bigquery::DataTransfer::V1::TimeBasedSchedule\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Bigquery::DataTransfer::V1::TimeBasedSchedule](./Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)) --- Time based transfer schedule options. This is the default schedule option.\n\n\nNote: The following fields are mutually exclusive: `time_based_schedule`, `manual_schedule`, `event_driven_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Bigquery::DataTransfer::V1::TimeBasedSchedule](./Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)) --- Time based transfer schedule options. This is the default schedule option.\n\n\n Note: The following fields are mutually exclusive: `time_based_schedule`, `manual_schedule`, `event_driven_schedule`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]
