2.4.0 (latest) 2.3.3 2.2.4 2.1.5 2.0.0 1.8.6 1.7.0 1.6.2 1.5.2 1.4.5 1.3.8 Reference documentation and code samples for the BigQuery Data Transfer V1 Client class ScheduleOptions.

Options customizing the data transfer schedule.

Generated from protobuf message `google.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. |
| `↳ start_time` | `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. The time when a data transfer can be triggered manually is not limited by this option. |
| `↳ end_time` | `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. 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\Timestamp|null` |   |

### hasStartTime

### clearStartTime

### setStartTime

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `Google\Protobuf\Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEndTime

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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\Timestamp|null` |   |

### hasEndTime

### clearEndTime

### setEndTime

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `Google\Protobuf\Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |