Reference documentation and code samples for the BigQuery Data Transfer V1 Client class ScheduleOptions.
Options customizing the data transfer schedule.
Generated from protobuf messagegoogle.cloud.bigquery.datatransfer.v1.ScheduleOptions
Namespace
Google \ Cloud \ BigQuery \ DataTransfer \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ disable_auto_scheduling
bool
If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
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. The time when a data transfer can be triggered manually is not limited by this option.
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. The time when a data transfer can be triggered manually is not limited by this option.
getDisableAutoScheduling
If true, automatic scheduling of data transfer runs for this configuration
will be disabled. The runs can be started on ad-hoc basis using
StartManualTransferRuns API. When automatic scheduling is disabled, the
TransferConfig.schedule field will be ignored.
Returns
Type
Description
bool
setDisableAutoScheduling
If true, automatic scheduling of data transfer runs for this configuration
will be disabled. The runs can be started on ad-hoc basis using
StartManualTransferRuns API. When automatic scheduling is disabled, the
TransferConfig.schedule field will be ignored.
Parameter
Name
Description
var
bool
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. The time when a data transfer can be triggered manually is not
limited by this option.
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. The time when a data transfer can be triggered manually is not
limited by this option.
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. The time when a data transfer can be triggered manually is not
limited by this option.
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. The time when a data transfer can be triggered manually is not
limited by this option.
[[["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 ScheduleOptions (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.ScheduleOptions)\n- [2.1.4](/php/docs/reference/cloud-bigquerydatatransfer/2.1.4/V1.ScheduleOptions)\n- [2.0.0](/php/docs/reference/cloud-bigquerydatatransfer/2.0.0/V1.ScheduleOptions)\n- [1.8.6](/php/docs/reference/cloud-bigquerydatatransfer/1.8.6/V1.ScheduleOptions)\n- [1.7.0](/php/docs/reference/cloud-bigquerydatatransfer/1.7.0/V1.ScheduleOptions)\n- [1.6.2](/php/docs/reference/cloud-bigquerydatatransfer/1.6.2/V1.ScheduleOptions)\n- [1.5.2](/php/docs/reference/cloud-bigquerydatatransfer/1.5.2/V1.ScheduleOptions)\n- [1.4.5](/php/docs/reference/cloud-bigquerydatatransfer/1.4.5/V1.ScheduleOptions)\n- [1.3.8](/php/docs/reference/cloud-bigquerydatatransfer/1.3.8/V1.ScheduleOptions) \nReference documentation and code samples for the BigQuery Data Transfer V1 Client class ScheduleOptions.\n\nOptions customizing the data transfer schedule.\n\nGenerated from protobuf message `google.cloud.bigquery.datatransfer.v1.ScheduleOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ DataTransfer \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDisableAutoScheduling\n\nIf true, automatic scheduling of data transfer runs for this configuration\nwill be disabled. The runs can be started on ad-hoc basis using\nStartManualTransferRuns API. When automatic scheduling is disabled, the\nTransferConfig.schedule field will be ignored.\n\n### setDisableAutoScheduling\n\nIf true, automatic scheduling of data transfer runs for this configuration\nwill be disabled. The runs can be started on ad-hoc basis using\nStartManualTransferRuns API. When automatic scheduling is disabled, the\nTransferConfig.schedule field will be ignored.\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. The time when a data transfer can be triggered manually is not\nlimited by this option.\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. The time when a data transfer can be triggered manually is not\nlimited by this option.\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. The time when a data transfer can be triggered manually is not\nlimited by this option.\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. The time when a data transfer can be triggered manually is not\nlimited by this option."]]
