Reference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::TimeBasedSchedule.
Options customizing the time based transfer schedule.
Options are migrated from the original ScheduleOptions message.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#end_time
defend_time()->::Google::Protobuf::Timestamp
Returns
(::Google::Protobuf::Timestamp) — Defines time to stop scheduling transfer runs. A transfer run cannot be
scheduled at or after the end time. The end time can be changed at any
moment.
value (::Google::Protobuf::Timestamp) — Defines time to stop scheduling transfer runs. A transfer run cannot be
scheduled at or after the end time. The end time can be changed at any
moment.
Returns
(::Google::Protobuf::Timestamp) — Defines time to stop scheduling transfer runs. A transfer run cannot be
scheduled at or after the end time. The end time can be changed at any
moment.
#schedule
defschedule()->::String
Returns
(::String) — Data transfer schedule.
If the data source does not support a custom schedule, this should be
empty. If it is empty, the default value for the data source will be used.
The specified times are in UTC.
Examples of valid format:
1st,3rd monday of month 15:30,
every wed,fri of jan,jun 13:15, and
first sunday of quarter 00:00.
See more explanation about the format here:
https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
NOTE: The minimum interval time between recurring transfers depends on the
data source; refer to the documentation for your data source.
#schedule=
defschedule=(value)->::String
Parameter
value (::String) — Data transfer schedule.
If the data source does not support a custom schedule, this should be
empty. If it is empty, the default value for the data source will be used.
The specified times are in UTC.
Examples of valid format:
1st,3rd monday of month 15:30,
every wed,fri of jan,jun 13:15, and
first sunday of quarter 00:00.
See more explanation about the format here:
https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
NOTE: The minimum interval time between recurring transfers depends on the
data source; refer to the documentation for your data source.
Returns
(::String) — Data transfer schedule.
If the data source does not support a custom schedule, this should be
empty. If it is empty, the default value for the data source will be used.
The specified times are in UTC.
Examples of valid format:
1st,3rd monday of month 15:30,
every wed,fri of jan,jun 13:15, and
first sunday of quarter 00:00.
See more explanation about the format here:
https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
NOTE: The minimum interval time between recurring transfers depends on the
data source; refer to the documentation for your data source.
#start_time
defstart_time()->::Google::Protobuf::Timestamp
Returns
(::Google::Protobuf::Timestamp) — Specifies time to start scheduling transfer runs. The first run will be
scheduled at or after the start time according to a recurrence pattern
defined in the schedule string. The start time can be changed at any
moment.
value (::Google::Protobuf::Timestamp) — Specifies time to start scheduling transfer runs. The first run will be
scheduled at or after the start time according to a recurrence pattern
defined in the schedule string. The start time can be changed at any
moment.
Returns
(::Google::Protobuf::Timestamp) — Specifies time to start scheduling transfer runs. The first run will be
scheduled at or after the start time according to a recurrence pattern
defined in the schedule string. The start time can be changed at any
moment.
[[["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::TimeBasedSchedule (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-TimeBasedSchedule)\n- [1.4.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.4.0/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [1.3.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.3.1/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [1.2.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.2.0/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [1.1.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.1.0/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [1.0.3](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/1.0.3/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.14.2](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.14.2/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.13.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.13.1/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.12.2](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.12.2/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.11.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.11.0/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.10.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.10.0/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.9.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.9.0/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.8.0](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.8.0/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.7.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.7.1/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.6.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.6.1/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.5.1](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.5.1/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule)\n- [0.4.6](/ruby/docs/reference/google-cloud-bigquery-data_transfer-v1/0.4.6/Google-Cloud-Bigquery-DataTransfer-V1-TimeBasedSchedule) \nReference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::TimeBasedSchedule.\n\nOptions customizing the time based transfer schedule.\nOptions are migrated from the original ScheduleOptions message. \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### #end_time\n\n def end_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.\n\n### #end_time=\n\n def end_time=(value) -\u003e ::Google::Protobuf::Timestamp\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. \n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.\n\n### #schedule\n\n def schedule() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\n\n\n NOTE: The minimum interval time between recurring transfers depends on the\n data source; refer to the documentation for your data source.\n\n### #schedule=\n\n def schedule=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\n\n\n NOTE: The minimum interval time between recurring transfers depends on the\ndata source; refer to the documentation for your data source. \n**Returns**\n\n- (::String) --- Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\n\n\n NOTE: The minimum interval time between recurring transfers depends on the\n data source; refer to the documentation for your data source.\n\n### #start_time\n\n def start_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.\n\n### #start_time=\n\n def start_time=(value) -\u003e ::Google::Protobuf::Timestamp\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. \n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment."]]
