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 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. |
| `↳ 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. |
| `↳ 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. |

### 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.

| **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.

| **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.

| **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.

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

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