|
1407 | 1407 | } |
1408 | 1408 | } |
1409 | 1409 | }, |
1410 | | - "revision": "20240806", |
| 1410 | + "revision": "20240914", |
1411 | 1411 | "rootUrl": "https://bigquerydatatransfer.googleapis.com/", |
1412 | 1412 | "schemas": { |
1413 | 1413 | "CheckValidCredsRequest": { |
|
1691 | 1691 | }, |
1692 | 1692 | "type": "object" |
1693 | 1693 | }, |
| 1694 | + "EventDrivenSchedule": { |
| 1695 | + "description": "Options customizing EventDriven transfers schedule.", |
| 1696 | + "id": "EventDrivenSchedule", |
| 1697 | + "properties": { |
| 1698 | + "pubsubSubscription": { |
| 1699 | + "description": "Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}", |
| 1700 | + "type": "string" |
| 1701 | + } |
| 1702 | + }, |
| 1703 | + "type": "object" |
| 1704 | + }, |
1694 | 1705 | "ListDataSourcesResponse": { |
1695 | 1706 | "description": "Returns list of supported data sources and their metadata.", |
1696 | 1707 | "id": "ListDataSourcesResponse", |
|
1822 | 1833 | }, |
1823 | 1834 | "type": "object" |
1824 | 1835 | }, |
| 1836 | + "ManualSchedule": { |
| 1837 | + "description": "Options customizing manual transfers schedule.", |
| 1838 | + "id": "ManualSchedule", |
| 1839 | + "properties": {}, |
| 1840 | + "type": "object" |
| 1841 | + }, |
1825 | 1842 | "ScheduleOptions": { |
1826 | 1843 | "description": "Options customizing the data transfer schedule.", |
1827 | 1844 | "id": "ScheduleOptions", |
|
1843 | 1860 | }, |
1844 | 1861 | "type": "object" |
1845 | 1862 | }, |
| 1863 | + "ScheduleOptionsV2": { |
| 1864 | + "description": "V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.", |
| 1865 | + "id": "ScheduleOptionsV2", |
| 1866 | + "properties": { |
| 1867 | + "eventDrivenSchedule": { |
| 1868 | + "$ref": "EventDrivenSchedule", |
| 1869 | + "description": "Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial." |
| 1870 | + }, |
| 1871 | + "manualSchedule": { |
| 1872 | + "$ref": "ManualSchedule", |
| 1873 | + "description": "Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true." |
| 1874 | + }, |
| 1875 | + "timeBasedSchedule": { |
| 1876 | + "$ref": "TimeBasedSchedule", |
| 1877 | + "description": "Time based transfer schedule options. This is the default schedule option." |
| 1878 | + } |
| 1879 | + }, |
| 1880 | + "type": "object" |
| 1881 | + }, |
1846 | 1882 | "ScheduleTransferRunsRequest": { |
1847 | 1883 | "description": "A request to schedule transfer runs for a time range.", |
1848 | 1884 | "id": "ScheduleTransferRunsRequest", |
|
1931 | 1967 | }, |
1932 | 1968 | "type": "object" |
1933 | 1969 | }, |
| 1970 | + "TimeBasedSchedule": { |
| 1971 | + "description": "Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.", |
| 1972 | + "id": "TimeBasedSchedule", |
| 1973 | + "properties": { |
| 1974 | + "endTime": { |
| 1975 | + "description": "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.", |
| 1976 | + "format": "google-datetime", |
| 1977 | + "type": "string" |
| 1978 | + }, |
| 1979 | + "schedule": { |
| 1980 | + "description": "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.", |
| 1981 | + "type": "string" |
| 1982 | + }, |
| 1983 | + "startTime": { |
| 1984 | + "description": "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.", |
| 1985 | + "format": "google-datetime", |
| 1986 | + "type": "string" |
| 1987 | + } |
| 1988 | + }, |
| 1989 | + "type": "object" |
| 1990 | + }, |
1934 | 1991 | "TimeRange": { |
1935 | 1992 | "description": "A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).", |
1936 | 1993 | "id": "TimeRange", |
|
1986 | 2043 | "$ref": "EncryptionConfiguration", |
1987 | 2044 | "description": "The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent." |
1988 | 2045 | }, |
| 2046 | + "error": { |
| 2047 | + "$ref": "Status", |
| 2048 | + "description": "Output only. Error code with detailed information about reason of the latest config failure.", |
| 2049 | + "readOnly": true |
| 2050 | + }, |
1989 | 2051 | "name": { |
1990 | 2052 | "description": "Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.", |
1991 | 2053 | "type": "string" |
|
2021 | 2083 | "$ref": "ScheduleOptions", |
2022 | 2084 | "description": "Options customizing the data transfer schedule." |
2023 | 2085 | }, |
| 2086 | + "scheduleOptionsV2": { |
| 2087 | + "$ref": "ScheduleOptionsV2", |
| 2088 | + "description": "Options customizing different types of data transfer schedule. This field replaces \"schedule\" and \"schedule_options\" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule." |
| 2089 | + }, |
2024 | 2090 | "state": { |
2025 | 2091 | "description": "Output only. State of the most recently updated transfer run.", |
2026 | 2092 | "enum": [ |
|
0 commit comments