Options customizing the time based transfer schedule.
Options are migrated from the original ScheduleOptions message.
Attributes
Name
Description
schedule
str
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
google.protobuf.timestamp_pb2.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.
end_time
google.protobuf.timestamp_pb2.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.
[[["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-07 UTC."],[],[],null,["# Class TimeBasedSchedule (3.19.2)\n\nVersion latestkeyboard_arrow_down\n\n- [3.19.2 (latest)](/python/docs/reference/bigquerydatatransfer/latest/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.19.1](/python/docs/reference/bigquerydatatransfer/3.19.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.18.0](/python/docs/reference/bigquerydatatransfer/3.18.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.17.1](/python/docs/reference/bigquerydatatransfer/3.17.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.16.0](/python/docs/reference/bigquerydatatransfer/3.16.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.15.7](/python/docs/reference/bigquerydatatransfer/3.15.7/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.14.1](/python/docs/reference/bigquerydatatransfer/3.14.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.13.0](/python/docs/reference/bigquerydatatransfer/3.13.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.12.1](/python/docs/reference/bigquerydatatransfer/3.12.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.11.2](/python/docs/reference/bigquerydatatransfer/3.11.2/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.10.1](/python/docs/reference/bigquerydatatransfer/3.10.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.9.0](/python/docs/reference/bigquerydatatransfer/3.9.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.8.0](/python/docs/reference/bigquerydatatransfer/3.8.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.7.3](/python/docs/reference/bigquerydatatransfer/3.7.3/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.6.2](/python/docs/reference/bigquerydatatransfer/3.6.2/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.5.0](/python/docs/reference/bigquerydatatransfer/3.5.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.4.1](/python/docs/reference/bigquerydatatransfer/3.4.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.3.4](/python/docs/reference/bigquerydatatransfer/3.3.4/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.2.0](/python/docs/reference/bigquerydatatransfer/3.2.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.1.1](/python/docs/reference/bigquerydatatransfer/3.1.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [3.0.1](/python/docs/reference/bigquerydatatransfer/3.0.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [2.1.2](/python/docs/reference/bigquerydatatransfer/2.1.2/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [2.0.0](/python/docs/reference/bigquerydatatransfer/2.0.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [1.1.3](/python/docs/reference/bigquerydatatransfer/1.1.3/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [1.0.0](/python/docs/reference/bigquerydatatransfer/1.0.0/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule)\n- [0.4.1](/python/docs/reference/bigquerydatatransfer/0.4.1/google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule) \n\n TimeBasedSchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nOptions customizing the time based transfer schedule.\nOptions are migrated from the original ScheduleOptions message."]]