Reference documentation and code samples for the BigQuery Data Transfer V1 Client class TimeBasedSchedule.
Options customizing the time based transfer schedule.
Options are migrated from the original ScheduleOptions message.
Generated from protobuf message google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule
Namespace
Google \ Cloud \ BigQuery \ DataTransfer \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ schedule
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.
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.
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.
getSchedule
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
Type
Description
string
setSchedule
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getStartTime
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.
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-09-04 UTC."],[],[],null,["# BigQuery Data Transfer V1 Client - Class TimeBasedSchedule (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.TimeBasedSchedule)\n- [2.1.4](/php/docs/reference/cloud-bigquerydatatransfer/2.1.4/V1.TimeBasedSchedule)\n- [2.0.0](/php/docs/reference/cloud-bigquerydatatransfer/2.0.0/V1.TimeBasedSchedule)\n- [1.8.6](/php/docs/reference/cloud-bigquerydatatransfer/1.8.6/V1.TimeBasedSchedule)\n- [1.7.0](/php/docs/reference/cloud-bigquerydatatransfer/1.7.0/V1.TimeBasedSchedule)\n- [1.6.2](/php/docs/reference/cloud-bigquerydatatransfer/1.6.2/V1.TimeBasedSchedule)\n- [1.5.2](/php/docs/reference/cloud-bigquerydatatransfer/1.5.2/V1.TimeBasedSchedule)\n- [1.4.5](/php/docs/reference/cloud-bigquerydatatransfer/1.4.5/V1.TimeBasedSchedule)\n- [1.3.8](/php/docs/reference/cloud-bigquerydatatransfer/1.3.8/V1.TimeBasedSchedule) \nReference documentation and code samples for the BigQuery Data Transfer V1 Client class TimeBasedSchedule.\n\nOptions customizing the time based transfer schedule.\n\nOptions are migrated from the original ScheduleOptions message.\n\nGenerated from protobuf message `google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ DataTransfer \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSchedule\n\nData transfer schedule.\n\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be used.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\n\u003chttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\u003e\nNOTE: The minimum interval time between recurring transfers depends on the\ndata source; refer to the documentation for your data source.\n\n### setSchedule\n\nData transfer schedule.\n\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be used.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\n\u003chttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\u003e\nNOTE: The minimum interval time between recurring transfers depends on the\ndata source; refer to the documentation for your data source.\n\n### getStartTime\n\nSpecifies time to start scheduling transfer runs. The first run will be\nscheduled at or after the start time according to a recurrence pattern\ndefined in the schedule string. The start time can be changed at any\nmoment.\n\n### hasStartTime\n\n### clearStartTime\n\n### setStartTime\n\nSpecifies time to start scheduling transfer runs. The first run will be\nscheduled at or after the start time according to a recurrence pattern\ndefined in the schedule string. The start time can be changed at any\nmoment.\n\n### getEndTime\n\nDefines time to stop scheduling transfer runs. A transfer run cannot be\nscheduled at or after the end time. The end time can be changed at any\nmoment.\n\n### hasEndTime\n\n### clearEndTime\n\n### setEndTime\n\nDefines time to stop scheduling transfer runs. A transfer run cannot be\nscheduled at or after the end time. The end time can be changed at any\nmoment."]]
