@maxim_mazurok/gapi.client.bigquerydatatransfer-v1 0.0.20220730
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +1938 -0
- package/package.json +20 -0
- package/readme.md +79 -0
- package/tests.ts +366 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,1938 @@
|
|
|
1
|
+
/* Type definitions for non-npm package BigQuery Data Transfer API v1 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/bigquery-transfer/
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://bigquerydatatransfer.googleapis.com/$discovery/rest?version=v1
|
|
13
|
+
// Revision: 20220730
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load BigQuery Data Transfer API v1 */
|
|
19
|
+
function load(urlOrObject: "https://bigquerydatatransfer.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "bigquerydatatransfer", version: "v1"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "bigquerydatatransfer", version: "v1", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace bigquerydatatransfer {
|
|
26
|
+
// tslint:disable-next-line:no-empty-interface
|
|
27
|
+
interface CheckValidCredsRequest {
|
|
28
|
+
}
|
|
29
|
+
interface CheckValidCredsResponse {
|
|
30
|
+
/** If set to `true`, the credentials exist and are valid. */
|
|
31
|
+
hasValidCreds?: boolean;
|
|
32
|
+
}
|
|
33
|
+
interface DataSource {
|
|
34
|
+
/** Indicates the type of authorization. */
|
|
35
|
+
authorizationType?: string;
|
|
36
|
+
/** Data source client id which should be used to receive refresh token. */
|
|
37
|
+
clientId?: string;
|
|
38
|
+
/**
|
|
39
|
+
* Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days
|
|
40
|
+
* later, so it's useful to refresh data automatically.
|
|
41
|
+
*/
|
|
42
|
+
dataRefreshType?: string;
|
|
43
|
+
/** Data source id. */
|
|
44
|
+
dataSourceId?: string;
|
|
45
|
+
/** Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. */
|
|
46
|
+
defaultDataRefreshWindowDays?: number;
|
|
47
|
+
/** Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. */
|
|
48
|
+
defaultSchedule?: string;
|
|
49
|
+
/** User friendly data source description string. */
|
|
50
|
+
description?: string;
|
|
51
|
+
/** User friendly data source name. */
|
|
52
|
+
displayName?: string;
|
|
53
|
+
/** Url for the help document for this data source. */
|
|
54
|
+
helpUrl?: string;
|
|
55
|
+
/** Disables backfilling and manual run scheduling for the data source. */
|
|
56
|
+
manualRunsDisabled?: boolean;
|
|
57
|
+
/** The minimum interval for scheduler to schedule runs. */
|
|
58
|
+
minimumScheduleInterval?: string;
|
|
59
|
+
/** Output only. Data source resource name. */
|
|
60
|
+
name?: string;
|
|
61
|
+
/** Data source parameters. */
|
|
62
|
+
parameters?: DataSourceParameter[];
|
|
63
|
+
/**
|
|
64
|
+
* Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g.,
|
|
65
|
+
* https://www.googleapis.com/auth/bigquery
|
|
66
|
+
*/
|
|
67
|
+
scopes?: string[];
|
|
68
|
+
/** Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule. */
|
|
69
|
+
supportsCustomSchedule?: boolean;
|
|
70
|
+
/** Deprecated. This field has no effect. */
|
|
71
|
+
supportsMultipleTransfers?: boolean;
|
|
72
|
+
/** Deprecated. This field has no effect. */
|
|
73
|
+
transferType?: string;
|
|
74
|
+
/** The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. */
|
|
75
|
+
updateDeadlineSeconds?: number;
|
|
76
|
+
}
|
|
77
|
+
interface DataSourceParameter {
|
|
78
|
+
/** All possible values for the parameter. */
|
|
79
|
+
allowedValues?: string[];
|
|
80
|
+
/** If true, it should not be used in new transfers, and it should not be visible to users. */
|
|
81
|
+
deprecated?: boolean;
|
|
82
|
+
/** Parameter description. */
|
|
83
|
+
description?: string;
|
|
84
|
+
/** Parameter display name in the user interface. */
|
|
85
|
+
displayName?: string;
|
|
86
|
+
/** Deprecated. This field has no effect. */
|
|
87
|
+
fields?: DataSourceParameter[];
|
|
88
|
+
/** Cannot be changed after initial creation. */
|
|
89
|
+
immutable?: boolean;
|
|
90
|
+
/** For integer and double values specifies maxminum allowed value. */
|
|
91
|
+
maxValue?: number;
|
|
92
|
+
/** For integer and double values specifies minimum allowed value. */
|
|
93
|
+
minValue?: number;
|
|
94
|
+
/** Parameter identifier. */
|
|
95
|
+
paramId?: string;
|
|
96
|
+
/** Deprecated. This field has no effect. */
|
|
97
|
+
recurse?: boolean;
|
|
98
|
+
/** Deprecated. This field has no effect. */
|
|
99
|
+
repeated?: boolean;
|
|
100
|
+
/** Is parameter required. */
|
|
101
|
+
required?: boolean;
|
|
102
|
+
/** Parameter type. */
|
|
103
|
+
type?: string;
|
|
104
|
+
/** Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values. */
|
|
105
|
+
validationDescription?: string;
|
|
106
|
+
/** URL to a help document to further explain the naming requirements. */
|
|
107
|
+
validationHelpUrl?: string;
|
|
108
|
+
/** Regular expression which can be used for parameter validation. */
|
|
109
|
+
validationRegex?: string;
|
|
110
|
+
}
|
|
111
|
+
interface EmailPreferences {
|
|
112
|
+
/** If true, email notifications will be sent on transfer run failures. */
|
|
113
|
+
enableFailureEmail?: boolean;
|
|
114
|
+
}
|
|
115
|
+
// tslint:disable-next-line:no-empty-interface
|
|
116
|
+
interface Empty {
|
|
117
|
+
}
|
|
118
|
+
interface EnrollDataSourcesRequest {
|
|
119
|
+
/** Data sources that are enrolled. It is required to provide at least one data source id. */
|
|
120
|
+
dataSourceIds?: string[];
|
|
121
|
+
}
|
|
122
|
+
interface ListDataSourcesResponse {
|
|
123
|
+
/** List of supported data sources and their transfer settings. */
|
|
124
|
+
dataSources?: DataSource[];
|
|
125
|
+
/** Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results. */
|
|
126
|
+
nextPageToken?: string;
|
|
127
|
+
}
|
|
128
|
+
interface ListLocationsResponse {
|
|
129
|
+
/** A list of locations that matches the specified filter in the request. */
|
|
130
|
+
locations?: Location[];
|
|
131
|
+
/** The standard List next-page token. */
|
|
132
|
+
nextPageToken?: string;
|
|
133
|
+
}
|
|
134
|
+
interface ListTransferConfigsResponse {
|
|
135
|
+
/**
|
|
136
|
+
* Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list
|
|
137
|
+
* results.
|
|
138
|
+
*/
|
|
139
|
+
nextPageToken?: string;
|
|
140
|
+
/** Output only. The stored pipeline transfer configurations. */
|
|
141
|
+
transferConfigs?: TransferConfig[];
|
|
142
|
+
}
|
|
143
|
+
interface ListTransferLogsResponse {
|
|
144
|
+
/** Output only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results. */
|
|
145
|
+
nextPageToken?: string;
|
|
146
|
+
/** Output only. The stored pipeline transfer messages. */
|
|
147
|
+
transferMessages?: TransferMessage[];
|
|
148
|
+
}
|
|
149
|
+
interface ListTransferRunsResponse {
|
|
150
|
+
/** Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results. */
|
|
151
|
+
nextPageToken?: string;
|
|
152
|
+
/** Output only. The stored pipeline transfer runs. */
|
|
153
|
+
transferRuns?: TransferRun[];
|
|
154
|
+
}
|
|
155
|
+
interface Location {
|
|
156
|
+
/** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
|
|
157
|
+
displayName?: string;
|
|
158
|
+
/** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
|
|
159
|
+
labels?: { [P in string]: string };
|
|
160
|
+
/** The canonical id for this location. For example: `"us-east1"`. */
|
|
161
|
+
locationId?: string;
|
|
162
|
+
/** Service-specific metadata. For example the available capacity at the given location. */
|
|
163
|
+
metadata?: { [P in string]: any };
|
|
164
|
+
/** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
|
|
165
|
+
name?: string;
|
|
166
|
+
}
|
|
167
|
+
interface ScheduleOptions {
|
|
168
|
+
/**
|
|
169
|
+
* 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
|
|
170
|
+
* automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
|
|
171
|
+
*/
|
|
172
|
+
disableAutoScheduling?: boolean;
|
|
173
|
+
/**
|
|
174
|
+
* 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
|
|
175
|
+
* can be trigerred manually is not limited by this option.
|
|
176
|
+
*/
|
|
177
|
+
endTime?: string;
|
|
178
|
+
/**
|
|
179
|
+
* 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
|
|
180
|
+
* start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
|
|
181
|
+
*/
|
|
182
|
+
startTime?: string;
|
|
183
|
+
}
|
|
184
|
+
interface ScheduleTransferRunsRequest {
|
|
185
|
+
/** Required. End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. */
|
|
186
|
+
endTime?: string;
|
|
187
|
+
/** Required. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. */
|
|
188
|
+
startTime?: string;
|
|
189
|
+
}
|
|
190
|
+
interface ScheduleTransferRunsResponse {
|
|
191
|
+
/** The transfer runs that were scheduled. */
|
|
192
|
+
runs?: TransferRun[];
|
|
193
|
+
}
|
|
194
|
+
interface StartManualTransferRunsRequest {
|
|
195
|
+
/** Specific run_time for a transfer run to be started. The requested_run_time must not be in the future. */
|
|
196
|
+
requestedRunTime?: string;
|
|
197
|
+
/** Time range for the transfer runs that should be started. */
|
|
198
|
+
requestedTimeRange?: TimeRange;
|
|
199
|
+
}
|
|
200
|
+
interface StartManualTransferRunsResponse {
|
|
201
|
+
/** The transfer runs that were created. */
|
|
202
|
+
runs?: TransferRun[];
|
|
203
|
+
}
|
|
204
|
+
interface Status {
|
|
205
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
206
|
+
code?: number;
|
|
207
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
208
|
+
details?: Array<{ [P in string]: any }>;
|
|
209
|
+
/**
|
|
210
|
+
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
|
|
211
|
+
* client.
|
|
212
|
+
*/
|
|
213
|
+
message?: string;
|
|
214
|
+
}
|
|
215
|
+
interface TimeRange {
|
|
216
|
+
/**
|
|
217
|
+
* End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range
|
|
218
|
+
* between start_time (inclusive) and end_time (exclusive).
|
|
219
|
+
*/
|
|
220
|
+
endTime?: string;
|
|
221
|
+
/**
|
|
222
|
+
* Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is
|
|
223
|
+
* in the range between start_time (inclusive) and end_time (exclusive).
|
|
224
|
+
*/
|
|
225
|
+
startTime?: string;
|
|
226
|
+
}
|
|
227
|
+
interface TransferConfig {
|
|
228
|
+
/**
|
|
229
|
+
* The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1],
|
|
230
|
+
* rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
|
|
231
|
+
*/
|
|
232
|
+
dataRefreshWindowDays?: number;
|
|
233
|
+
/** Output only. Region in which BigQuery dataset is located. */
|
|
234
|
+
datasetRegion?: string;
|
|
235
|
+
/**
|
|
236
|
+
* Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call:
|
|
237
|
+
* https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
|
|
238
|
+
*/
|
|
239
|
+
dataSourceId?: string;
|
|
240
|
+
/** The BigQuery target dataset id. */
|
|
241
|
+
destinationDatasetId?: string;
|
|
242
|
+
/** Is this config disabled. When set to true, no runs are scheduled for a given transfer. */
|
|
243
|
+
disabled?: boolean;
|
|
244
|
+
/** User specified display name for the data transfer. */
|
|
245
|
+
displayName?: string;
|
|
246
|
+
/** Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. */
|
|
247
|
+
emailPreferences?: EmailPreferences;
|
|
248
|
+
/**
|
|
249
|
+
* The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a
|
|
250
|
+
* uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
|
|
251
|
+
*/
|
|
252
|
+
name?: string;
|
|
253
|
+
/** Output only. Next time when data transfer will run. */
|
|
254
|
+
nextRunTime?: string;
|
|
255
|
+
/**
|
|
256
|
+
* Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is:
|
|
257
|
+
* `projects/{project}/topics/{topic}`
|
|
258
|
+
*/
|
|
259
|
+
notificationPubsubTopic?: string;
|
|
260
|
+
/**
|
|
261
|
+
* Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not
|
|
262
|
+
* available, this field will not be populated.
|
|
263
|
+
*/
|
|
264
|
+
ownerInfo?: UserInfo;
|
|
265
|
+
/**
|
|
266
|
+
* Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud
|
|
267
|
+
* Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
|
|
268
|
+
*/
|
|
269
|
+
params?: { [P in string]: any };
|
|
270
|
+
/**
|
|
271
|
+
* 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
|
|
272
|
+
* 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
|
|
273
|
+
* 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
|
|
274
|
+
* transfers depends on the data source; refer to the documentation for your data source.
|
|
275
|
+
*/
|
|
276
|
+
schedule?: string;
|
|
277
|
+
/** Options customizing the data transfer schedule. */
|
|
278
|
+
scheduleOptions?: ScheduleOptions;
|
|
279
|
+
/** Output only. State of the most recently updated transfer run. */
|
|
280
|
+
state?: string;
|
|
281
|
+
/** Output only. Data transfer modification time. Ignored by server on input. */
|
|
282
|
+
updateTime?: string;
|
|
283
|
+
/** Deprecated. Unique ID of the user on whose behalf transfer is done. */
|
|
284
|
+
userId?: string;
|
|
285
|
+
}
|
|
286
|
+
interface TransferMessage {
|
|
287
|
+
/** Message text. */
|
|
288
|
+
messageText?: string;
|
|
289
|
+
/** Time when message was logged. */
|
|
290
|
+
messageTime?: string;
|
|
291
|
+
/** Message severity. */
|
|
292
|
+
severity?: string;
|
|
293
|
+
}
|
|
294
|
+
interface TransferRun {
|
|
295
|
+
/** Output only. Data source id. */
|
|
296
|
+
dataSourceId?: string;
|
|
297
|
+
/** Output only. The BigQuery target dataset id. */
|
|
298
|
+
destinationDatasetId?: string;
|
|
299
|
+
/** Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from. */
|
|
300
|
+
emailPreferences?: EmailPreferences;
|
|
301
|
+
/** Output only. Time when transfer run ended. Parameter ignored by server for input requests. */
|
|
302
|
+
endTime?: string;
|
|
303
|
+
/** Status of the transfer run. */
|
|
304
|
+
errorStatus?: Status;
|
|
305
|
+
/**
|
|
306
|
+
* The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored
|
|
307
|
+
* when creating a transfer run.
|
|
308
|
+
*/
|
|
309
|
+
name?: string;
|
|
310
|
+
/** Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}` */
|
|
311
|
+
notificationPubsubTopic?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the
|
|
314
|
+
* parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
|
|
315
|
+
*/
|
|
316
|
+
params?: { [P in string]: any };
|
|
317
|
+
/** For batch transfer runs, specifies the date and time of the data should be ingested. */
|
|
318
|
+
runTime?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE:
|
|
321
|
+
* the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
|
|
322
|
+
*/
|
|
323
|
+
schedule?: string;
|
|
324
|
+
/** Minimum time after which a transfer run can be started. */
|
|
325
|
+
scheduleTime?: string;
|
|
326
|
+
/** Output only. Time when transfer run was started. Parameter ignored by server for input requests. */
|
|
327
|
+
startTime?: string;
|
|
328
|
+
/** Data transfer run state. Ignored for input requests. */
|
|
329
|
+
state?: string;
|
|
330
|
+
/** Output only. Last time the data transfer run state was updated. */
|
|
331
|
+
updateTime?: string;
|
|
332
|
+
/** Deprecated. Unique ID of the user on whose behalf transfer is done. */
|
|
333
|
+
userId?: string;
|
|
334
|
+
}
|
|
335
|
+
interface UserInfo {
|
|
336
|
+
/** E-mail address of the user. */
|
|
337
|
+
email?: string;
|
|
338
|
+
}
|
|
339
|
+
interface DataSourcesResource {
|
|
340
|
+
/** Returns true if valid credentials exist for the given data source and requesting user. */
|
|
341
|
+
checkValidCreds(request: {
|
|
342
|
+
/** V1 error format. */
|
|
343
|
+
"$.xgafv"?: string;
|
|
344
|
+
/** OAuth access token. */
|
|
345
|
+
access_token?: string;
|
|
346
|
+
/** Data format for response. */
|
|
347
|
+
alt?: string;
|
|
348
|
+
/** JSONP */
|
|
349
|
+
callback?: string;
|
|
350
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
351
|
+
fields?: string;
|
|
352
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
353
|
+
key?: string;
|
|
354
|
+
/** Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. */
|
|
355
|
+
name: string;
|
|
356
|
+
/** OAuth 2.0 token for the current user. */
|
|
357
|
+
oauth_token?: string;
|
|
358
|
+
/** Returns response with indentations and line breaks. */
|
|
359
|
+
prettyPrint?: boolean;
|
|
360
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
361
|
+
quotaUser?: string;
|
|
362
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
363
|
+
upload_protocol?: string;
|
|
364
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
365
|
+
uploadType?: string;
|
|
366
|
+
/** Request body */
|
|
367
|
+
resource: CheckValidCredsRequest;
|
|
368
|
+
}): Request<CheckValidCredsResponse>;
|
|
369
|
+
checkValidCreds(request: {
|
|
370
|
+
/** V1 error format. */
|
|
371
|
+
"$.xgafv"?: string;
|
|
372
|
+
/** OAuth access token. */
|
|
373
|
+
access_token?: string;
|
|
374
|
+
/** Data format for response. */
|
|
375
|
+
alt?: string;
|
|
376
|
+
/** JSONP */
|
|
377
|
+
callback?: string;
|
|
378
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
379
|
+
fields?: string;
|
|
380
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
381
|
+
key?: string;
|
|
382
|
+
/** Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. */
|
|
383
|
+
name: string;
|
|
384
|
+
/** OAuth 2.0 token for the current user. */
|
|
385
|
+
oauth_token?: string;
|
|
386
|
+
/** Returns response with indentations and line breaks. */
|
|
387
|
+
prettyPrint?: boolean;
|
|
388
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
389
|
+
quotaUser?: string;
|
|
390
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
391
|
+
upload_protocol?: string;
|
|
392
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
393
|
+
uploadType?: string;
|
|
394
|
+
},
|
|
395
|
+
body: CheckValidCredsRequest): Request<CheckValidCredsResponse>;
|
|
396
|
+
/** Retrieves a supported data source and returns its settings. */
|
|
397
|
+
get(request?: {
|
|
398
|
+
/** V1 error format. */
|
|
399
|
+
"$.xgafv"?: string;
|
|
400
|
+
/** OAuth access token. */
|
|
401
|
+
access_token?: string;
|
|
402
|
+
/** Data format for response. */
|
|
403
|
+
alt?: string;
|
|
404
|
+
/** JSONP */
|
|
405
|
+
callback?: string;
|
|
406
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
407
|
+
fields?: string;
|
|
408
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
409
|
+
key?: string;
|
|
410
|
+
/**
|
|
411
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or
|
|
412
|
+
* `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
|
|
413
|
+
*/
|
|
414
|
+
name: string;
|
|
415
|
+
/** OAuth 2.0 token for the current user. */
|
|
416
|
+
oauth_token?: string;
|
|
417
|
+
/** Returns response with indentations and line breaks. */
|
|
418
|
+
prettyPrint?: boolean;
|
|
419
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
420
|
+
quotaUser?: string;
|
|
421
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
422
|
+
upload_protocol?: string;
|
|
423
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
424
|
+
uploadType?: string;
|
|
425
|
+
}): Request<DataSource>;
|
|
426
|
+
/** Lists supported data sources and returns their settings. */
|
|
427
|
+
list(request?: {
|
|
428
|
+
/** V1 error format. */
|
|
429
|
+
"$.xgafv"?: string;
|
|
430
|
+
/** OAuth access token. */
|
|
431
|
+
access_token?: string;
|
|
432
|
+
/** Data format for response. */
|
|
433
|
+
alt?: string;
|
|
434
|
+
/** JSONP */
|
|
435
|
+
callback?: string;
|
|
436
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
437
|
+
fields?: string;
|
|
438
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
439
|
+
key?: string;
|
|
440
|
+
/** OAuth 2.0 token for the current user. */
|
|
441
|
+
oauth_token?: string;
|
|
442
|
+
/** Page size. The default page size is the maximum value of 1000 results. */
|
|
443
|
+
pageSize?: number;
|
|
444
|
+
/**
|
|
445
|
+
* Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a
|
|
446
|
+
* `next_page` token, which can be used as the `page_token` value to request the next page of list results.
|
|
447
|
+
*/
|
|
448
|
+
pageToken?: string;
|
|
449
|
+
/** Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` */
|
|
450
|
+
parent: string;
|
|
451
|
+
/** Returns response with indentations and line breaks. */
|
|
452
|
+
prettyPrint?: boolean;
|
|
453
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
454
|
+
quotaUser?: string;
|
|
455
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
456
|
+
upload_protocol?: string;
|
|
457
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
458
|
+
uploadType?: string;
|
|
459
|
+
}): Request<ListDataSourcesResponse>;
|
|
460
|
+
}
|
|
461
|
+
interface DataSourcesResource {
|
|
462
|
+
/** Returns true if valid credentials exist for the given data source and requesting user. */
|
|
463
|
+
checkValidCreds(request: {
|
|
464
|
+
/** V1 error format. */
|
|
465
|
+
"$.xgafv"?: string;
|
|
466
|
+
/** OAuth access token. */
|
|
467
|
+
access_token?: string;
|
|
468
|
+
/** Data format for response. */
|
|
469
|
+
alt?: string;
|
|
470
|
+
/** JSONP */
|
|
471
|
+
callback?: string;
|
|
472
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
473
|
+
fields?: string;
|
|
474
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
475
|
+
key?: string;
|
|
476
|
+
/** Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. */
|
|
477
|
+
name: string;
|
|
478
|
+
/** OAuth 2.0 token for the current user. */
|
|
479
|
+
oauth_token?: string;
|
|
480
|
+
/** Returns response with indentations and line breaks. */
|
|
481
|
+
prettyPrint?: boolean;
|
|
482
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
483
|
+
quotaUser?: string;
|
|
484
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
485
|
+
upload_protocol?: string;
|
|
486
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
487
|
+
uploadType?: string;
|
|
488
|
+
/** Request body */
|
|
489
|
+
resource: CheckValidCredsRequest;
|
|
490
|
+
}): Request<CheckValidCredsResponse>;
|
|
491
|
+
checkValidCreds(request: {
|
|
492
|
+
/** V1 error format. */
|
|
493
|
+
"$.xgafv"?: string;
|
|
494
|
+
/** OAuth access token. */
|
|
495
|
+
access_token?: string;
|
|
496
|
+
/** Data format for response. */
|
|
497
|
+
alt?: string;
|
|
498
|
+
/** JSONP */
|
|
499
|
+
callback?: string;
|
|
500
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
501
|
+
fields?: string;
|
|
502
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
503
|
+
key?: string;
|
|
504
|
+
/** Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. */
|
|
505
|
+
name: string;
|
|
506
|
+
/** OAuth 2.0 token for the current user. */
|
|
507
|
+
oauth_token?: string;
|
|
508
|
+
/** Returns response with indentations and line breaks. */
|
|
509
|
+
prettyPrint?: boolean;
|
|
510
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
511
|
+
quotaUser?: string;
|
|
512
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
513
|
+
upload_protocol?: string;
|
|
514
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
515
|
+
uploadType?: string;
|
|
516
|
+
},
|
|
517
|
+
body: CheckValidCredsRequest): Request<CheckValidCredsResponse>;
|
|
518
|
+
/** Retrieves a supported data source and returns its settings. */
|
|
519
|
+
get(request?: {
|
|
520
|
+
/** V1 error format. */
|
|
521
|
+
"$.xgafv"?: string;
|
|
522
|
+
/** OAuth access token. */
|
|
523
|
+
access_token?: string;
|
|
524
|
+
/** Data format for response. */
|
|
525
|
+
alt?: string;
|
|
526
|
+
/** JSONP */
|
|
527
|
+
callback?: string;
|
|
528
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
529
|
+
fields?: string;
|
|
530
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
531
|
+
key?: string;
|
|
532
|
+
/**
|
|
533
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or
|
|
534
|
+
* `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
|
|
535
|
+
*/
|
|
536
|
+
name: string;
|
|
537
|
+
/** OAuth 2.0 token for the current user. */
|
|
538
|
+
oauth_token?: string;
|
|
539
|
+
/** Returns response with indentations and line breaks. */
|
|
540
|
+
prettyPrint?: boolean;
|
|
541
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
542
|
+
quotaUser?: string;
|
|
543
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
544
|
+
upload_protocol?: string;
|
|
545
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
546
|
+
uploadType?: string;
|
|
547
|
+
}): Request<DataSource>;
|
|
548
|
+
/** Lists supported data sources and returns their settings. */
|
|
549
|
+
list(request?: {
|
|
550
|
+
/** V1 error format. */
|
|
551
|
+
"$.xgafv"?: string;
|
|
552
|
+
/** OAuth access token. */
|
|
553
|
+
access_token?: string;
|
|
554
|
+
/** Data format for response. */
|
|
555
|
+
alt?: string;
|
|
556
|
+
/** JSONP */
|
|
557
|
+
callback?: string;
|
|
558
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
559
|
+
fields?: string;
|
|
560
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
561
|
+
key?: string;
|
|
562
|
+
/** OAuth 2.0 token for the current user. */
|
|
563
|
+
oauth_token?: string;
|
|
564
|
+
/** Page size. The default page size is the maximum value of 1000 results. */
|
|
565
|
+
pageSize?: number;
|
|
566
|
+
/**
|
|
567
|
+
* Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a
|
|
568
|
+
* `next_page` token, which can be used as the `page_token` value to request the next page of list results.
|
|
569
|
+
*/
|
|
570
|
+
pageToken?: string;
|
|
571
|
+
/** Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` */
|
|
572
|
+
parent: string;
|
|
573
|
+
/** Returns response with indentations and line breaks. */
|
|
574
|
+
prettyPrint?: boolean;
|
|
575
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
576
|
+
quotaUser?: string;
|
|
577
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
578
|
+
upload_protocol?: string;
|
|
579
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
580
|
+
uploadType?: string;
|
|
581
|
+
}): Request<ListDataSourcesResponse>;
|
|
582
|
+
}
|
|
583
|
+
interface TransferLogsResource {
|
|
584
|
+
/** Returns log messages for the transfer run. */
|
|
585
|
+
list(request?: {
|
|
586
|
+
/** V1 error format. */
|
|
587
|
+
"$.xgafv"?: string;
|
|
588
|
+
/** OAuth access token. */
|
|
589
|
+
access_token?: string;
|
|
590
|
+
/** Data format for response. */
|
|
591
|
+
alt?: string;
|
|
592
|
+
/** JSONP */
|
|
593
|
+
callback?: string;
|
|
594
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
595
|
+
fields?: string;
|
|
596
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
597
|
+
key?: string;
|
|
598
|
+
/** Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. */
|
|
599
|
+
messageTypes?: string | string[];
|
|
600
|
+
/** OAuth 2.0 token for the current user. */
|
|
601
|
+
oauth_token?: string;
|
|
602
|
+
/** Page size. The default page size is the maximum value of 1000 results. */
|
|
603
|
+
pageSize?: number;
|
|
604
|
+
/**
|
|
605
|
+
* Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a
|
|
606
|
+
* `next_page` token, which can be used as the `page_token` value to request the next page of list results.
|
|
607
|
+
*/
|
|
608
|
+
pageToken?: string;
|
|
609
|
+
/**
|
|
610
|
+
* Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
|
611
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
|
612
|
+
*/
|
|
613
|
+
parent: string;
|
|
614
|
+
/** Returns response with indentations and line breaks. */
|
|
615
|
+
prettyPrint?: boolean;
|
|
616
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
617
|
+
quotaUser?: string;
|
|
618
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
619
|
+
upload_protocol?: string;
|
|
620
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
621
|
+
uploadType?: string;
|
|
622
|
+
}): Request<ListTransferLogsResponse>;
|
|
623
|
+
}
|
|
624
|
+
interface RunsResource {
|
|
625
|
+
/** Deletes the specified transfer run. */
|
|
626
|
+
delete(request?: {
|
|
627
|
+
/** V1 error format. */
|
|
628
|
+
"$.xgafv"?: string;
|
|
629
|
+
/** OAuth access token. */
|
|
630
|
+
access_token?: string;
|
|
631
|
+
/** Data format for response. */
|
|
632
|
+
alt?: string;
|
|
633
|
+
/** JSONP */
|
|
634
|
+
callback?: string;
|
|
635
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
636
|
+
fields?: string;
|
|
637
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
638
|
+
key?: string;
|
|
639
|
+
/**
|
|
640
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
|
641
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
|
642
|
+
*/
|
|
643
|
+
name: string;
|
|
644
|
+
/** OAuth 2.0 token for the current user. */
|
|
645
|
+
oauth_token?: string;
|
|
646
|
+
/** Returns response with indentations and line breaks. */
|
|
647
|
+
prettyPrint?: boolean;
|
|
648
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
649
|
+
quotaUser?: string;
|
|
650
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
651
|
+
upload_protocol?: string;
|
|
652
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
653
|
+
uploadType?: string;
|
|
654
|
+
}): Request<{}>;
|
|
655
|
+
/** Returns information about the particular transfer run. */
|
|
656
|
+
get(request?: {
|
|
657
|
+
/** V1 error format. */
|
|
658
|
+
"$.xgafv"?: string;
|
|
659
|
+
/** OAuth access token. */
|
|
660
|
+
access_token?: string;
|
|
661
|
+
/** Data format for response. */
|
|
662
|
+
alt?: string;
|
|
663
|
+
/** JSONP */
|
|
664
|
+
callback?: string;
|
|
665
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
666
|
+
fields?: string;
|
|
667
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
668
|
+
key?: string;
|
|
669
|
+
/**
|
|
670
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
|
671
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
|
672
|
+
*/
|
|
673
|
+
name: string;
|
|
674
|
+
/** OAuth 2.0 token for the current user. */
|
|
675
|
+
oauth_token?: string;
|
|
676
|
+
/** Returns response with indentations and line breaks. */
|
|
677
|
+
prettyPrint?: boolean;
|
|
678
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
679
|
+
quotaUser?: string;
|
|
680
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
681
|
+
upload_protocol?: string;
|
|
682
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
683
|
+
uploadType?: string;
|
|
684
|
+
}): Request<TransferRun>;
|
|
685
|
+
/** Returns information about running and completed transfer runs. */
|
|
686
|
+
list(request?: {
|
|
687
|
+
/** V1 error format. */
|
|
688
|
+
"$.xgafv"?: string;
|
|
689
|
+
/** OAuth access token. */
|
|
690
|
+
access_token?: string;
|
|
691
|
+
/** Data format for response. */
|
|
692
|
+
alt?: string;
|
|
693
|
+
/** JSONP */
|
|
694
|
+
callback?: string;
|
|
695
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
696
|
+
fields?: string;
|
|
697
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
698
|
+
key?: string;
|
|
699
|
+
/** OAuth 2.0 token for the current user. */
|
|
700
|
+
oauth_token?: string;
|
|
701
|
+
/** Page size. The default page size is the maximum value of 1000 results. */
|
|
702
|
+
pageSize?: number;
|
|
703
|
+
/**
|
|
704
|
+
* Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a
|
|
705
|
+
* `next_page` token, which can be used as the `page_token` value to request the next page of list results.
|
|
706
|
+
*/
|
|
707
|
+
pageToken?: string;
|
|
708
|
+
/**
|
|
709
|
+
* Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is:
|
|
710
|
+
* `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
|
711
|
+
*/
|
|
712
|
+
parent: string;
|
|
713
|
+
/** Returns response with indentations and line breaks. */
|
|
714
|
+
prettyPrint?: boolean;
|
|
715
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
716
|
+
quotaUser?: string;
|
|
717
|
+
/** Indicates how run attempts are to be pulled. */
|
|
718
|
+
runAttempt?: string;
|
|
719
|
+
/** When specified, only transfer runs with requested states are returned. */
|
|
720
|
+
states?: string | string[];
|
|
721
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
722
|
+
upload_protocol?: string;
|
|
723
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
724
|
+
uploadType?: string;
|
|
725
|
+
}): Request<ListTransferRunsResponse>;
|
|
726
|
+
transferLogs: TransferLogsResource;
|
|
727
|
+
}
|
|
728
|
+
interface TransferConfigsResource {
|
|
729
|
+
/** Creates a new data transfer configuration. */
|
|
730
|
+
create(request: {
|
|
731
|
+
/** V1 error format. */
|
|
732
|
+
"$.xgafv"?: string;
|
|
733
|
+
/** OAuth access token. */
|
|
734
|
+
access_token?: string;
|
|
735
|
+
/** Data format for response. */
|
|
736
|
+
alt?: string;
|
|
737
|
+
/**
|
|
738
|
+
* Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are
|
|
739
|
+
* needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?
|
|
740
|
+
* client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * The client_id is the OAuth client_id of the a data source
|
|
741
|
+
* as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is
|
|
742
|
+
* used to create the transfer config.
|
|
743
|
+
*/
|
|
744
|
+
authorizationCode?: string;
|
|
745
|
+
/** JSONP */
|
|
746
|
+
callback?: string;
|
|
747
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
748
|
+
fields?: string;
|
|
749
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
750
|
+
key?: string;
|
|
751
|
+
/** OAuth 2.0 token for the current user. */
|
|
752
|
+
oauth_token?: string;
|
|
753
|
+
/**
|
|
754
|
+
* Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or
|
|
755
|
+
* projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
|
|
756
|
+
*/
|
|
757
|
+
parent: string;
|
|
758
|
+
/** Returns response with indentations and line breaks. */
|
|
759
|
+
prettyPrint?: boolean;
|
|
760
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
761
|
+
quotaUser?: string;
|
|
762
|
+
/**
|
|
763
|
+
* Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling
|
|
764
|
+
* this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list
|
|
765
|
+
* of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
|
|
766
|
+
*/
|
|
767
|
+
serviceAccountName?: string;
|
|
768
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
769
|
+
upload_protocol?: string;
|
|
770
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
771
|
+
uploadType?: string;
|
|
772
|
+
/**
|
|
773
|
+
* Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In
|
|
774
|
+
* order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? client_id=client_id&scope=data_source_scopes
|
|
775
|
+
* &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. *
|
|
776
|
+
* data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
|
|
777
|
+
*/
|
|
778
|
+
versionInfo?: string;
|
|
779
|
+
/** Request body */
|
|
780
|
+
resource: TransferConfig;
|
|
781
|
+
}): Request<TransferConfig>;
|
|
782
|
+
create(request: {
|
|
783
|
+
/** V1 error format. */
|
|
784
|
+
"$.xgafv"?: string;
|
|
785
|
+
/** OAuth access token. */
|
|
786
|
+
access_token?: string;
|
|
787
|
+
/** Data format for response. */
|
|
788
|
+
alt?: string;
|
|
789
|
+
/**
|
|
790
|
+
* Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are
|
|
791
|
+
* needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?
|
|
792
|
+
* client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * The client_id is the OAuth client_id of the a data source
|
|
793
|
+
* as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is
|
|
794
|
+
* used to create the transfer config.
|
|
795
|
+
*/
|
|
796
|
+
authorizationCode?: string;
|
|
797
|
+
/** JSONP */
|
|
798
|
+
callback?: string;
|
|
799
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
800
|
+
fields?: string;
|
|
801
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
802
|
+
key?: string;
|
|
803
|
+
/** OAuth 2.0 token for the current user. */
|
|
804
|
+
oauth_token?: string;
|
|
805
|
+
/**
|
|
806
|
+
* Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or
|
|
807
|
+
* projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
|
|
808
|
+
*/
|
|
809
|
+
parent: string;
|
|
810
|
+
/** Returns response with indentations and line breaks. */
|
|
811
|
+
prettyPrint?: boolean;
|
|
812
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
813
|
+
quotaUser?: string;
|
|
814
|
+
/**
|
|
815
|
+
* Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling
|
|
816
|
+
* this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list
|
|
817
|
+
* of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
|
|
818
|
+
*/
|
|
819
|
+
serviceAccountName?: string;
|
|
820
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
821
|
+
upload_protocol?: string;
|
|
822
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
823
|
+
uploadType?: string;
|
|
824
|
+
/**
|
|
825
|
+
* Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In
|
|
826
|
+
* order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? client_id=client_id&scope=data_source_scopes
|
|
827
|
+
* &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. *
|
|
828
|
+
* data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
|
|
829
|
+
*/
|
|
830
|
+
versionInfo?: string;
|
|
831
|
+
},
|
|
832
|
+
body: TransferConfig): Request<TransferConfig>;
|
|
833
|
+
/** Deletes a data transfer configuration, including any associated transfer runs and logs. */
|
|
834
|
+
delete(request?: {
|
|
835
|
+
/** V1 error format. */
|
|
836
|
+
"$.xgafv"?: string;
|
|
837
|
+
/** OAuth access token. */
|
|
838
|
+
access_token?: string;
|
|
839
|
+
/** Data format for response. */
|
|
840
|
+
alt?: string;
|
|
841
|
+
/** JSONP */
|
|
842
|
+
callback?: string;
|
|
843
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
844
|
+
fields?: string;
|
|
845
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
846
|
+
key?: string;
|
|
847
|
+
/**
|
|
848
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or
|
|
849
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
|
|
850
|
+
*/
|
|
851
|
+
name: string;
|
|
852
|
+
/** OAuth 2.0 token for the current user. */
|
|
853
|
+
oauth_token?: string;
|
|
854
|
+
/** Returns response with indentations and line breaks. */
|
|
855
|
+
prettyPrint?: boolean;
|
|
856
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
857
|
+
quotaUser?: string;
|
|
858
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
859
|
+
upload_protocol?: string;
|
|
860
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
861
|
+
uploadType?: string;
|
|
862
|
+
}): Request<{}>;
|
|
863
|
+
/** Returns information about a data transfer config. */
|
|
864
|
+
get(request?: {
|
|
865
|
+
/** V1 error format. */
|
|
866
|
+
"$.xgafv"?: string;
|
|
867
|
+
/** OAuth access token. */
|
|
868
|
+
access_token?: string;
|
|
869
|
+
/** Data format for response. */
|
|
870
|
+
alt?: string;
|
|
871
|
+
/** JSONP */
|
|
872
|
+
callback?: string;
|
|
873
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
874
|
+
fields?: string;
|
|
875
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
876
|
+
key?: string;
|
|
877
|
+
/**
|
|
878
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or
|
|
879
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
|
|
880
|
+
*/
|
|
881
|
+
name: string;
|
|
882
|
+
/** OAuth 2.0 token for the current user. */
|
|
883
|
+
oauth_token?: string;
|
|
884
|
+
/** Returns response with indentations and line breaks. */
|
|
885
|
+
prettyPrint?: boolean;
|
|
886
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
887
|
+
quotaUser?: string;
|
|
888
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
889
|
+
upload_protocol?: string;
|
|
890
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
891
|
+
uploadType?: string;
|
|
892
|
+
}): Request<TransferConfig>;
|
|
893
|
+
/** Returns information about all transfer configs owned by a project in the specified location. */
|
|
894
|
+
list(request?: {
|
|
895
|
+
/** V1 error format. */
|
|
896
|
+
"$.xgafv"?: string;
|
|
897
|
+
/** OAuth access token. */
|
|
898
|
+
access_token?: string;
|
|
899
|
+
/** Data format for response. */
|
|
900
|
+
alt?: string;
|
|
901
|
+
/** JSONP */
|
|
902
|
+
callback?: string;
|
|
903
|
+
/** When specified, only configurations of requested data sources are returned. */
|
|
904
|
+
dataSourceIds?: string | string[];
|
|
905
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
906
|
+
fields?: string;
|
|
907
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
908
|
+
key?: string;
|
|
909
|
+
/** OAuth 2.0 token for the current user. */
|
|
910
|
+
oauth_token?: string;
|
|
911
|
+
/** Page size. The default page size is the maximum value of 1000 results. */
|
|
912
|
+
pageSize?: number;
|
|
913
|
+
/**
|
|
914
|
+
* Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page`
|
|
915
|
+
* token, which can be used as the `page_token` value to request the next page of list results.
|
|
916
|
+
*/
|
|
917
|
+
pageToken?: string;
|
|
918
|
+
/** Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` */
|
|
919
|
+
parent: string;
|
|
920
|
+
/** Returns response with indentations and line breaks. */
|
|
921
|
+
prettyPrint?: boolean;
|
|
922
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
923
|
+
quotaUser?: string;
|
|
924
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
925
|
+
upload_protocol?: string;
|
|
926
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
927
|
+
uploadType?: string;
|
|
928
|
+
}): Request<ListTransferConfigsResponse>;
|
|
929
|
+
/** Updates a data transfer configuration. All fields must be set, even if they are not updated. */
|
|
930
|
+
patch(request: {
|
|
931
|
+
/** V1 error format. */
|
|
932
|
+
"$.xgafv"?: string;
|
|
933
|
+
/** OAuth access token. */
|
|
934
|
+
access_token?: string;
|
|
935
|
+
/** Data format for response. */
|
|
936
|
+
alt?: string;
|
|
937
|
+
/**
|
|
938
|
+
* Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are
|
|
939
|
+
* needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?
|
|
940
|
+
* client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * The client_id is the OAuth client_id of the a data source
|
|
941
|
+
* as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is
|
|
942
|
+
* used to update the transfer config.
|
|
943
|
+
*/
|
|
944
|
+
authorizationCode?: string;
|
|
945
|
+
/** JSONP */
|
|
946
|
+
callback?: string;
|
|
947
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
948
|
+
fields?: string;
|
|
949
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
950
|
+
key?: string;
|
|
951
|
+
/**
|
|
952
|
+
* The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is
|
|
953
|
+
* usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
|
|
954
|
+
*/
|
|
955
|
+
name: string;
|
|
956
|
+
/** OAuth 2.0 token for the current user. */
|
|
957
|
+
oauth_token?: string;
|
|
958
|
+
/** Returns response with indentations and line breaks. */
|
|
959
|
+
prettyPrint?: boolean;
|
|
960
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
961
|
+
quotaUser?: string;
|
|
962
|
+
/**
|
|
963
|
+
* Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling
|
|
964
|
+
* this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list
|
|
965
|
+
* of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
|
|
966
|
+
*/
|
|
967
|
+
serviceAccountName?: string;
|
|
968
|
+
/** Required. Required list of fields to be updated in this request. */
|
|
969
|
+
updateMask?: string;
|
|
970
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
971
|
+
upload_protocol?: string;
|
|
972
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
973
|
+
uploadType?: string;
|
|
974
|
+
/**
|
|
975
|
+
* Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In
|
|
976
|
+
* order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? client_id=client_id&scope=data_source_scopes
|
|
977
|
+
* &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. *
|
|
978
|
+
* data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
|
|
979
|
+
*/
|
|
980
|
+
versionInfo?: string;
|
|
981
|
+
/** Request body */
|
|
982
|
+
resource: TransferConfig;
|
|
983
|
+
}): Request<TransferConfig>;
|
|
984
|
+
patch(request: {
|
|
985
|
+
/** V1 error format. */
|
|
986
|
+
"$.xgafv"?: string;
|
|
987
|
+
/** OAuth access token. */
|
|
988
|
+
access_token?: string;
|
|
989
|
+
/** Data format for response. */
|
|
990
|
+
alt?: string;
|
|
991
|
+
/**
|
|
992
|
+
* Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are
|
|
993
|
+
* needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?
|
|
994
|
+
* client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * The client_id is the OAuth client_id of the a data source
|
|
995
|
+
* as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is
|
|
996
|
+
* used to update the transfer config.
|
|
997
|
+
*/
|
|
998
|
+
authorizationCode?: string;
|
|
999
|
+
/** JSONP */
|
|
1000
|
+
callback?: string;
|
|
1001
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1002
|
+
fields?: string;
|
|
1003
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1004
|
+
key?: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is
|
|
1007
|
+
* usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
|
|
1008
|
+
*/
|
|
1009
|
+
name: string;
|
|
1010
|
+
/** OAuth 2.0 token for the current user. */
|
|
1011
|
+
oauth_token?: string;
|
|
1012
|
+
/** Returns response with indentations and line breaks. */
|
|
1013
|
+
prettyPrint?: boolean;
|
|
1014
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1015
|
+
quotaUser?: string;
|
|
1016
|
+
/**
|
|
1017
|
+
* Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling
|
|
1018
|
+
* this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list
|
|
1019
|
+
* of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
|
|
1020
|
+
*/
|
|
1021
|
+
serviceAccountName?: string;
|
|
1022
|
+
/** Required. Required list of fields to be updated in this request. */
|
|
1023
|
+
updateMask?: string;
|
|
1024
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1025
|
+
upload_protocol?: string;
|
|
1026
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1027
|
+
uploadType?: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In
|
|
1030
|
+
* order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? client_id=client_id&scope=data_source_scopes
|
|
1031
|
+
* &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. *
|
|
1032
|
+
* data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
|
|
1033
|
+
*/
|
|
1034
|
+
versionInfo?: string;
|
|
1035
|
+
},
|
|
1036
|
+
body: TransferConfig): Request<TransferConfig>;
|
|
1037
|
+
/**
|
|
1038
|
+
* Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note
|
|
1039
|
+
* that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
|
|
1040
|
+
*/
|
|
1041
|
+
scheduleRuns(request: {
|
|
1042
|
+
/** V1 error format. */
|
|
1043
|
+
"$.xgafv"?: string;
|
|
1044
|
+
/** OAuth access token. */
|
|
1045
|
+
access_token?: string;
|
|
1046
|
+
/** Data format for response. */
|
|
1047
|
+
alt?: string;
|
|
1048
|
+
/** JSONP */
|
|
1049
|
+
callback?: string;
|
|
1050
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1051
|
+
fields?: string;
|
|
1052
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1053
|
+
key?: string;
|
|
1054
|
+
/** OAuth 2.0 token for the current user. */
|
|
1055
|
+
oauth_token?: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or
|
|
1058
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
|
1059
|
+
*/
|
|
1060
|
+
parent: string;
|
|
1061
|
+
/** Returns response with indentations and line breaks. */
|
|
1062
|
+
prettyPrint?: boolean;
|
|
1063
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1064
|
+
quotaUser?: string;
|
|
1065
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1066
|
+
upload_protocol?: string;
|
|
1067
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1068
|
+
uploadType?: string;
|
|
1069
|
+
/** Request body */
|
|
1070
|
+
resource: ScheduleTransferRunsRequest;
|
|
1071
|
+
}): Request<ScheduleTransferRunsResponse>;
|
|
1072
|
+
scheduleRuns(request: {
|
|
1073
|
+
/** V1 error format. */
|
|
1074
|
+
"$.xgafv"?: string;
|
|
1075
|
+
/** OAuth access token. */
|
|
1076
|
+
access_token?: string;
|
|
1077
|
+
/** Data format for response. */
|
|
1078
|
+
alt?: string;
|
|
1079
|
+
/** JSONP */
|
|
1080
|
+
callback?: string;
|
|
1081
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1082
|
+
fields?: string;
|
|
1083
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1084
|
+
key?: string;
|
|
1085
|
+
/** OAuth 2.0 token for the current user. */
|
|
1086
|
+
oauth_token?: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or
|
|
1089
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
|
1090
|
+
*/
|
|
1091
|
+
parent: string;
|
|
1092
|
+
/** Returns response with indentations and line breaks. */
|
|
1093
|
+
prettyPrint?: boolean;
|
|
1094
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1095
|
+
quotaUser?: string;
|
|
1096
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1097
|
+
upload_protocol?: string;
|
|
1098
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1099
|
+
uploadType?: string;
|
|
1100
|
+
},
|
|
1101
|
+
body: ScheduleTransferRunsRequest): Request<ScheduleTransferRunsResponse>;
|
|
1102
|
+
/**
|
|
1103
|
+
* Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time
|
|
1104
|
+
* (inclusive) and end_time (exclusive), or for a specific run_time.
|
|
1105
|
+
*/
|
|
1106
|
+
startManualRuns(request: {
|
|
1107
|
+
/** V1 error format. */
|
|
1108
|
+
"$.xgafv"?: string;
|
|
1109
|
+
/** OAuth access token. */
|
|
1110
|
+
access_token?: string;
|
|
1111
|
+
/** Data format for response. */
|
|
1112
|
+
alt?: string;
|
|
1113
|
+
/** JSONP */
|
|
1114
|
+
callback?: string;
|
|
1115
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1116
|
+
fields?: string;
|
|
1117
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1118
|
+
key?: string;
|
|
1119
|
+
/** OAuth 2.0 token for the current user. */
|
|
1120
|
+
oauth_token?: string;
|
|
1121
|
+
/** Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */
|
|
1122
|
+
parent: string;
|
|
1123
|
+
/** Returns response with indentations and line breaks. */
|
|
1124
|
+
prettyPrint?: boolean;
|
|
1125
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1126
|
+
quotaUser?: string;
|
|
1127
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1128
|
+
upload_protocol?: string;
|
|
1129
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1130
|
+
uploadType?: string;
|
|
1131
|
+
/** Request body */
|
|
1132
|
+
resource: StartManualTransferRunsRequest;
|
|
1133
|
+
}): Request<StartManualTransferRunsResponse>;
|
|
1134
|
+
startManualRuns(request: {
|
|
1135
|
+
/** V1 error format. */
|
|
1136
|
+
"$.xgafv"?: string;
|
|
1137
|
+
/** OAuth access token. */
|
|
1138
|
+
access_token?: string;
|
|
1139
|
+
/** Data format for response. */
|
|
1140
|
+
alt?: string;
|
|
1141
|
+
/** JSONP */
|
|
1142
|
+
callback?: string;
|
|
1143
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1144
|
+
fields?: string;
|
|
1145
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1146
|
+
key?: string;
|
|
1147
|
+
/** OAuth 2.0 token for the current user. */
|
|
1148
|
+
oauth_token?: string;
|
|
1149
|
+
/** Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */
|
|
1150
|
+
parent: string;
|
|
1151
|
+
/** Returns response with indentations and line breaks. */
|
|
1152
|
+
prettyPrint?: boolean;
|
|
1153
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1154
|
+
quotaUser?: string;
|
|
1155
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1156
|
+
upload_protocol?: string;
|
|
1157
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1158
|
+
uploadType?: string;
|
|
1159
|
+
},
|
|
1160
|
+
body: StartManualTransferRunsRequest): Request<StartManualTransferRunsResponse>;
|
|
1161
|
+
runs: RunsResource;
|
|
1162
|
+
}
|
|
1163
|
+
interface LocationsResource {
|
|
1164
|
+
/**
|
|
1165
|
+
* Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will
|
|
1166
|
+
* appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web
|
|
1167
|
+
* UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
|
|
1168
|
+
*/
|
|
1169
|
+
enrollDataSources(request: {
|
|
1170
|
+
/** V1 error format. */
|
|
1171
|
+
"$.xgafv"?: string;
|
|
1172
|
+
/** OAuth access token. */
|
|
1173
|
+
access_token?: string;
|
|
1174
|
+
/** Data format for response. */
|
|
1175
|
+
alt?: string;
|
|
1176
|
+
/** JSONP */
|
|
1177
|
+
callback?: string;
|
|
1178
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1179
|
+
fields?: string;
|
|
1180
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1181
|
+
key?: string;
|
|
1182
|
+
/** The name of the project resource in the form: `projects/{project_id}` */
|
|
1183
|
+
name: string;
|
|
1184
|
+
/** OAuth 2.0 token for the current user. */
|
|
1185
|
+
oauth_token?: string;
|
|
1186
|
+
/** Returns response with indentations and line breaks. */
|
|
1187
|
+
prettyPrint?: boolean;
|
|
1188
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1189
|
+
quotaUser?: string;
|
|
1190
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1191
|
+
upload_protocol?: string;
|
|
1192
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1193
|
+
uploadType?: string;
|
|
1194
|
+
/** Request body */
|
|
1195
|
+
resource: EnrollDataSourcesRequest;
|
|
1196
|
+
}): Request<{}>;
|
|
1197
|
+
enrollDataSources(request: {
|
|
1198
|
+
/** V1 error format. */
|
|
1199
|
+
"$.xgafv"?: string;
|
|
1200
|
+
/** OAuth access token. */
|
|
1201
|
+
access_token?: string;
|
|
1202
|
+
/** Data format for response. */
|
|
1203
|
+
alt?: string;
|
|
1204
|
+
/** JSONP */
|
|
1205
|
+
callback?: string;
|
|
1206
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1207
|
+
fields?: string;
|
|
1208
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1209
|
+
key?: string;
|
|
1210
|
+
/** The name of the project resource in the form: `projects/{project_id}` */
|
|
1211
|
+
name: string;
|
|
1212
|
+
/** OAuth 2.0 token for the current user. */
|
|
1213
|
+
oauth_token?: string;
|
|
1214
|
+
/** Returns response with indentations and line breaks. */
|
|
1215
|
+
prettyPrint?: boolean;
|
|
1216
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1217
|
+
quotaUser?: string;
|
|
1218
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1219
|
+
upload_protocol?: string;
|
|
1220
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1221
|
+
uploadType?: string;
|
|
1222
|
+
},
|
|
1223
|
+
body: EnrollDataSourcesRequest): Request<{}>;
|
|
1224
|
+
/** Gets information about a location. */
|
|
1225
|
+
get(request?: {
|
|
1226
|
+
/** V1 error format. */
|
|
1227
|
+
"$.xgafv"?: string;
|
|
1228
|
+
/** OAuth access token. */
|
|
1229
|
+
access_token?: string;
|
|
1230
|
+
/** Data format for response. */
|
|
1231
|
+
alt?: string;
|
|
1232
|
+
/** JSONP */
|
|
1233
|
+
callback?: string;
|
|
1234
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1235
|
+
fields?: string;
|
|
1236
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1237
|
+
key?: string;
|
|
1238
|
+
/** Resource name for the location. */
|
|
1239
|
+
name: string;
|
|
1240
|
+
/** OAuth 2.0 token for the current user. */
|
|
1241
|
+
oauth_token?: string;
|
|
1242
|
+
/** Returns response with indentations and line breaks. */
|
|
1243
|
+
prettyPrint?: boolean;
|
|
1244
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1245
|
+
quotaUser?: string;
|
|
1246
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1247
|
+
upload_protocol?: string;
|
|
1248
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1249
|
+
uploadType?: string;
|
|
1250
|
+
}): Request<Location>;
|
|
1251
|
+
/** Lists information about the supported locations for this service. */
|
|
1252
|
+
list(request?: {
|
|
1253
|
+
/** V1 error format. */
|
|
1254
|
+
"$.xgafv"?: string;
|
|
1255
|
+
/** OAuth access token. */
|
|
1256
|
+
access_token?: string;
|
|
1257
|
+
/** Data format for response. */
|
|
1258
|
+
alt?: string;
|
|
1259
|
+
/** JSONP */
|
|
1260
|
+
callback?: string;
|
|
1261
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1262
|
+
fields?: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in
|
|
1265
|
+
* [AIP-160](https://google.aip.dev/160).
|
|
1266
|
+
*/
|
|
1267
|
+
filter?: string;
|
|
1268
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1269
|
+
key?: string;
|
|
1270
|
+
/** The resource that owns the locations collection, if applicable. */
|
|
1271
|
+
name: string;
|
|
1272
|
+
/** OAuth 2.0 token for the current user. */
|
|
1273
|
+
oauth_token?: string;
|
|
1274
|
+
/** The maximum number of results to return. If not set, the service selects a default. */
|
|
1275
|
+
pageSize?: number;
|
|
1276
|
+
/** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
|
|
1277
|
+
pageToken?: string;
|
|
1278
|
+
/** Returns response with indentations and line breaks. */
|
|
1279
|
+
prettyPrint?: boolean;
|
|
1280
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1281
|
+
quotaUser?: string;
|
|
1282
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1283
|
+
upload_protocol?: string;
|
|
1284
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1285
|
+
uploadType?: string;
|
|
1286
|
+
}): Request<ListLocationsResponse>;
|
|
1287
|
+
dataSources: DataSourcesResource;
|
|
1288
|
+
transferConfigs: TransferConfigsResource;
|
|
1289
|
+
}
|
|
1290
|
+
interface TransferLogsResource {
|
|
1291
|
+
/** Returns log messages for the transfer run. */
|
|
1292
|
+
list(request?: {
|
|
1293
|
+
/** V1 error format. */
|
|
1294
|
+
"$.xgafv"?: string;
|
|
1295
|
+
/** OAuth access token. */
|
|
1296
|
+
access_token?: string;
|
|
1297
|
+
/** Data format for response. */
|
|
1298
|
+
alt?: string;
|
|
1299
|
+
/** JSONP */
|
|
1300
|
+
callback?: string;
|
|
1301
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1302
|
+
fields?: string;
|
|
1303
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1304
|
+
key?: string;
|
|
1305
|
+
/** Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. */
|
|
1306
|
+
messageTypes?: string | string[];
|
|
1307
|
+
/** OAuth 2.0 token for the current user. */
|
|
1308
|
+
oauth_token?: string;
|
|
1309
|
+
/** Page size. The default page size is the maximum value of 1000 results. */
|
|
1310
|
+
pageSize?: number;
|
|
1311
|
+
/**
|
|
1312
|
+
* Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a
|
|
1313
|
+
* `next_page` token, which can be used as the `page_token` value to request the next page of list results.
|
|
1314
|
+
*/
|
|
1315
|
+
pageToken?: string;
|
|
1316
|
+
/**
|
|
1317
|
+
* Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
|
1318
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
|
1319
|
+
*/
|
|
1320
|
+
parent: string;
|
|
1321
|
+
/** Returns response with indentations and line breaks. */
|
|
1322
|
+
prettyPrint?: boolean;
|
|
1323
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1324
|
+
quotaUser?: string;
|
|
1325
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1326
|
+
upload_protocol?: string;
|
|
1327
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1328
|
+
uploadType?: string;
|
|
1329
|
+
}): Request<ListTransferLogsResponse>;
|
|
1330
|
+
}
|
|
1331
|
+
interface RunsResource {
|
|
1332
|
+
/** Deletes the specified transfer run. */
|
|
1333
|
+
delete(request?: {
|
|
1334
|
+
/** V1 error format. */
|
|
1335
|
+
"$.xgafv"?: string;
|
|
1336
|
+
/** OAuth access token. */
|
|
1337
|
+
access_token?: string;
|
|
1338
|
+
/** Data format for response. */
|
|
1339
|
+
alt?: string;
|
|
1340
|
+
/** JSONP */
|
|
1341
|
+
callback?: string;
|
|
1342
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1343
|
+
fields?: string;
|
|
1344
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1345
|
+
key?: string;
|
|
1346
|
+
/**
|
|
1347
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
|
1348
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
|
1349
|
+
*/
|
|
1350
|
+
name: string;
|
|
1351
|
+
/** OAuth 2.0 token for the current user. */
|
|
1352
|
+
oauth_token?: string;
|
|
1353
|
+
/** Returns response with indentations and line breaks. */
|
|
1354
|
+
prettyPrint?: boolean;
|
|
1355
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1356
|
+
quotaUser?: string;
|
|
1357
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1358
|
+
upload_protocol?: string;
|
|
1359
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1360
|
+
uploadType?: string;
|
|
1361
|
+
}): Request<{}>;
|
|
1362
|
+
/** Returns information about the particular transfer run. */
|
|
1363
|
+
get(request?: {
|
|
1364
|
+
/** V1 error format. */
|
|
1365
|
+
"$.xgafv"?: string;
|
|
1366
|
+
/** OAuth access token. */
|
|
1367
|
+
access_token?: string;
|
|
1368
|
+
/** Data format for response. */
|
|
1369
|
+
alt?: string;
|
|
1370
|
+
/** JSONP */
|
|
1371
|
+
callback?: string;
|
|
1372
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1373
|
+
fields?: string;
|
|
1374
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1375
|
+
key?: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
|
1378
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
|
1379
|
+
*/
|
|
1380
|
+
name: string;
|
|
1381
|
+
/** OAuth 2.0 token for the current user. */
|
|
1382
|
+
oauth_token?: string;
|
|
1383
|
+
/** Returns response with indentations and line breaks. */
|
|
1384
|
+
prettyPrint?: boolean;
|
|
1385
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1386
|
+
quotaUser?: string;
|
|
1387
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1388
|
+
upload_protocol?: string;
|
|
1389
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1390
|
+
uploadType?: string;
|
|
1391
|
+
}): Request<TransferRun>;
|
|
1392
|
+
/** Returns information about running and completed transfer runs. */
|
|
1393
|
+
list(request?: {
|
|
1394
|
+
/** V1 error format. */
|
|
1395
|
+
"$.xgafv"?: string;
|
|
1396
|
+
/** OAuth access token. */
|
|
1397
|
+
access_token?: string;
|
|
1398
|
+
/** Data format for response. */
|
|
1399
|
+
alt?: string;
|
|
1400
|
+
/** JSONP */
|
|
1401
|
+
callback?: string;
|
|
1402
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1403
|
+
fields?: string;
|
|
1404
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1405
|
+
key?: string;
|
|
1406
|
+
/** OAuth 2.0 token for the current user. */
|
|
1407
|
+
oauth_token?: string;
|
|
1408
|
+
/** Page size. The default page size is the maximum value of 1000 results. */
|
|
1409
|
+
pageSize?: number;
|
|
1410
|
+
/**
|
|
1411
|
+
* Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a
|
|
1412
|
+
* `next_page` token, which can be used as the `page_token` value to request the next page of list results.
|
|
1413
|
+
*/
|
|
1414
|
+
pageToken?: string;
|
|
1415
|
+
/**
|
|
1416
|
+
* Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is:
|
|
1417
|
+
* `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
|
1418
|
+
*/
|
|
1419
|
+
parent: string;
|
|
1420
|
+
/** Returns response with indentations and line breaks. */
|
|
1421
|
+
prettyPrint?: boolean;
|
|
1422
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1423
|
+
quotaUser?: string;
|
|
1424
|
+
/** Indicates how run attempts are to be pulled. */
|
|
1425
|
+
runAttempt?: string;
|
|
1426
|
+
/** When specified, only transfer runs with requested states are returned. */
|
|
1427
|
+
states?: string | string[];
|
|
1428
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1429
|
+
upload_protocol?: string;
|
|
1430
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1431
|
+
uploadType?: string;
|
|
1432
|
+
}): Request<ListTransferRunsResponse>;
|
|
1433
|
+
transferLogs: TransferLogsResource;
|
|
1434
|
+
}
|
|
1435
|
+
interface TransferConfigsResource {
|
|
1436
|
+
/** Creates a new data transfer configuration. */
|
|
1437
|
+
create(request: {
|
|
1438
|
+
/** V1 error format. */
|
|
1439
|
+
"$.xgafv"?: string;
|
|
1440
|
+
/** OAuth access token. */
|
|
1441
|
+
access_token?: string;
|
|
1442
|
+
/** Data format for response. */
|
|
1443
|
+
alt?: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are
|
|
1446
|
+
* needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?
|
|
1447
|
+
* client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * The client_id is the OAuth client_id of the a data source
|
|
1448
|
+
* as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is
|
|
1449
|
+
* used to create the transfer config.
|
|
1450
|
+
*/
|
|
1451
|
+
authorizationCode?: string;
|
|
1452
|
+
/** JSONP */
|
|
1453
|
+
callback?: string;
|
|
1454
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1455
|
+
fields?: string;
|
|
1456
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1457
|
+
key?: string;
|
|
1458
|
+
/** OAuth 2.0 token for the current user. */
|
|
1459
|
+
oauth_token?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or
|
|
1462
|
+
* projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
|
|
1463
|
+
*/
|
|
1464
|
+
parent: string;
|
|
1465
|
+
/** Returns response with indentations and line breaks. */
|
|
1466
|
+
prettyPrint?: boolean;
|
|
1467
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1468
|
+
quotaUser?: string;
|
|
1469
|
+
/**
|
|
1470
|
+
* Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling
|
|
1471
|
+
* this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list
|
|
1472
|
+
* of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
|
|
1473
|
+
*/
|
|
1474
|
+
serviceAccountName?: string;
|
|
1475
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1476
|
+
upload_protocol?: string;
|
|
1477
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1478
|
+
uploadType?: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In
|
|
1481
|
+
* order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? client_id=client_id&scope=data_source_scopes
|
|
1482
|
+
* &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. *
|
|
1483
|
+
* data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
|
|
1484
|
+
*/
|
|
1485
|
+
versionInfo?: string;
|
|
1486
|
+
/** Request body */
|
|
1487
|
+
resource: TransferConfig;
|
|
1488
|
+
}): Request<TransferConfig>;
|
|
1489
|
+
create(request: {
|
|
1490
|
+
/** V1 error format. */
|
|
1491
|
+
"$.xgafv"?: string;
|
|
1492
|
+
/** OAuth access token. */
|
|
1493
|
+
access_token?: string;
|
|
1494
|
+
/** Data format for response. */
|
|
1495
|
+
alt?: string;
|
|
1496
|
+
/**
|
|
1497
|
+
* Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are
|
|
1498
|
+
* needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?
|
|
1499
|
+
* client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * The client_id is the OAuth client_id of the a data source
|
|
1500
|
+
* as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is
|
|
1501
|
+
* used to create the transfer config.
|
|
1502
|
+
*/
|
|
1503
|
+
authorizationCode?: string;
|
|
1504
|
+
/** JSONP */
|
|
1505
|
+
callback?: string;
|
|
1506
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1507
|
+
fields?: string;
|
|
1508
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1509
|
+
key?: string;
|
|
1510
|
+
/** OAuth 2.0 token for the current user. */
|
|
1511
|
+
oauth_token?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or
|
|
1514
|
+
* projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
|
|
1515
|
+
*/
|
|
1516
|
+
parent: string;
|
|
1517
|
+
/** Returns response with indentations and line breaks. */
|
|
1518
|
+
prettyPrint?: boolean;
|
|
1519
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1520
|
+
quotaUser?: string;
|
|
1521
|
+
/**
|
|
1522
|
+
* Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling
|
|
1523
|
+
* this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list
|
|
1524
|
+
* of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
|
|
1525
|
+
*/
|
|
1526
|
+
serviceAccountName?: string;
|
|
1527
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1528
|
+
upload_protocol?: string;
|
|
1529
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1530
|
+
uploadType?: string;
|
|
1531
|
+
/**
|
|
1532
|
+
* Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In
|
|
1533
|
+
* order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? client_id=client_id&scope=data_source_scopes
|
|
1534
|
+
* &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. *
|
|
1535
|
+
* data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
|
|
1536
|
+
*/
|
|
1537
|
+
versionInfo?: string;
|
|
1538
|
+
},
|
|
1539
|
+
body: TransferConfig): Request<TransferConfig>;
|
|
1540
|
+
/** Deletes a data transfer configuration, including any associated transfer runs and logs. */
|
|
1541
|
+
delete(request?: {
|
|
1542
|
+
/** V1 error format. */
|
|
1543
|
+
"$.xgafv"?: string;
|
|
1544
|
+
/** OAuth access token. */
|
|
1545
|
+
access_token?: string;
|
|
1546
|
+
/** Data format for response. */
|
|
1547
|
+
alt?: string;
|
|
1548
|
+
/** JSONP */
|
|
1549
|
+
callback?: string;
|
|
1550
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1551
|
+
fields?: string;
|
|
1552
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1553
|
+
key?: string;
|
|
1554
|
+
/**
|
|
1555
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or
|
|
1556
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
|
|
1557
|
+
*/
|
|
1558
|
+
name: string;
|
|
1559
|
+
/** OAuth 2.0 token for the current user. */
|
|
1560
|
+
oauth_token?: string;
|
|
1561
|
+
/** Returns response with indentations and line breaks. */
|
|
1562
|
+
prettyPrint?: boolean;
|
|
1563
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1564
|
+
quotaUser?: string;
|
|
1565
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1566
|
+
upload_protocol?: string;
|
|
1567
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1568
|
+
uploadType?: string;
|
|
1569
|
+
}): Request<{}>;
|
|
1570
|
+
/** Returns information about a data transfer config. */
|
|
1571
|
+
get(request?: {
|
|
1572
|
+
/** V1 error format. */
|
|
1573
|
+
"$.xgafv"?: string;
|
|
1574
|
+
/** OAuth access token. */
|
|
1575
|
+
access_token?: string;
|
|
1576
|
+
/** Data format for response. */
|
|
1577
|
+
alt?: string;
|
|
1578
|
+
/** JSONP */
|
|
1579
|
+
callback?: string;
|
|
1580
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1581
|
+
fields?: string;
|
|
1582
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1583
|
+
key?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or
|
|
1586
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
|
|
1587
|
+
*/
|
|
1588
|
+
name: string;
|
|
1589
|
+
/** OAuth 2.0 token for the current user. */
|
|
1590
|
+
oauth_token?: string;
|
|
1591
|
+
/** Returns response with indentations and line breaks. */
|
|
1592
|
+
prettyPrint?: boolean;
|
|
1593
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1594
|
+
quotaUser?: string;
|
|
1595
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1596
|
+
upload_protocol?: string;
|
|
1597
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1598
|
+
uploadType?: string;
|
|
1599
|
+
}): Request<TransferConfig>;
|
|
1600
|
+
/** Returns information about all transfer configs owned by a project in the specified location. */
|
|
1601
|
+
list(request?: {
|
|
1602
|
+
/** V1 error format. */
|
|
1603
|
+
"$.xgafv"?: string;
|
|
1604
|
+
/** OAuth access token. */
|
|
1605
|
+
access_token?: string;
|
|
1606
|
+
/** Data format for response. */
|
|
1607
|
+
alt?: string;
|
|
1608
|
+
/** JSONP */
|
|
1609
|
+
callback?: string;
|
|
1610
|
+
/** When specified, only configurations of requested data sources are returned. */
|
|
1611
|
+
dataSourceIds?: string | string[];
|
|
1612
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1613
|
+
fields?: string;
|
|
1614
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1615
|
+
key?: string;
|
|
1616
|
+
/** OAuth 2.0 token for the current user. */
|
|
1617
|
+
oauth_token?: string;
|
|
1618
|
+
/** Page size. The default page size is the maximum value of 1000 results. */
|
|
1619
|
+
pageSize?: number;
|
|
1620
|
+
/**
|
|
1621
|
+
* Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page`
|
|
1622
|
+
* token, which can be used as the `page_token` value to request the next page of list results.
|
|
1623
|
+
*/
|
|
1624
|
+
pageToken?: string;
|
|
1625
|
+
/** Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` */
|
|
1626
|
+
parent: string;
|
|
1627
|
+
/** Returns response with indentations and line breaks. */
|
|
1628
|
+
prettyPrint?: boolean;
|
|
1629
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1630
|
+
quotaUser?: string;
|
|
1631
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1632
|
+
upload_protocol?: string;
|
|
1633
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1634
|
+
uploadType?: string;
|
|
1635
|
+
}): Request<ListTransferConfigsResponse>;
|
|
1636
|
+
/** Updates a data transfer configuration. All fields must be set, even if they are not updated. */
|
|
1637
|
+
patch(request: {
|
|
1638
|
+
/** V1 error format. */
|
|
1639
|
+
"$.xgafv"?: string;
|
|
1640
|
+
/** OAuth access token. */
|
|
1641
|
+
access_token?: string;
|
|
1642
|
+
/** Data format for response. */
|
|
1643
|
+
alt?: string;
|
|
1644
|
+
/**
|
|
1645
|
+
* Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are
|
|
1646
|
+
* needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?
|
|
1647
|
+
* client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * The client_id is the OAuth client_id of the a data source
|
|
1648
|
+
* as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is
|
|
1649
|
+
* used to update the transfer config.
|
|
1650
|
+
*/
|
|
1651
|
+
authorizationCode?: string;
|
|
1652
|
+
/** JSONP */
|
|
1653
|
+
callback?: string;
|
|
1654
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1655
|
+
fields?: string;
|
|
1656
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1657
|
+
key?: string;
|
|
1658
|
+
/**
|
|
1659
|
+
* The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is
|
|
1660
|
+
* usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
|
|
1661
|
+
*/
|
|
1662
|
+
name: string;
|
|
1663
|
+
/** OAuth 2.0 token for the current user. */
|
|
1664
|
+
oauth_token?: string;
|
|
1665
|
+
/** Returns response with indentations and line breaks. */
|
|
1666
|
+
prettyPrint?: boolean;
|
|
1667
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1668
|
+
quotaUser?: string;
|
|
1669
|
+
/**
|
|
1670
|
+
* Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling
|
|
1671
|
+
* this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list
|
|
1672
|
+
* of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
|
|
1673
|
+
*/
|
|
1674
|
+
serviceAccountName?: string;
|
|
1675
|
+
/** Required. Required list of fields to be updated in this request. */
|
|
1676
|
+
updateMask?: string;
|
|
1677
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1678
|
+
upload_protocol?: string;
|
|
1679
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1680
|
+
uploadType?: string;
|
|
1681
|
+
/**
|
|
1682
|
+
* Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In
|
|
1683
|
+
* order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? client_id=client_id&scope=data_source_scopes
|
|
1684
|
+
* &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. *
|
|
1685
|
+
* data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
|
|
1686
|
+
*/
|
|
1687
|
+
versionInfo?: string;
|
|
1688
|
+
/** Request body */
|
|
1689
|
+
resource: TransferConfig;
|
|
1690
|
+
}): Request<TransferConfig>;
|
|
1691
|
+
patch(request: {
|
|
1692
|
+
/** V1 error format. */
|
|
1693
|
+
"$.xgafv"?: string;
|
|
1694
|
+
/** OAuth access token. */
|
|
1695
|
+
access_token?: string;
|
|
1696
|
+
/** Data format for response. */
|
|
1697
|
+
alt?: string;
|
|
1698
|
+
/**
|
|
1699
|
+
* Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are
|
|
1700
|
+
* needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?
|
|
1701
|
+
* client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * The client_id is the OAuth client_id of the a data source
|
|
1702
|
+
* as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is
|
|
1703
|
+
* used to update the transfer config.
|
|
1704
|
+
*/
|
|
1705
|
+
authorizationCode?: string;
|
|
1706
|
+
/** JSONP */
|
|
1707
|
+
callback?: string;
|
|
1708
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1709
|
+
fields?: string;
|
|
1710
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1711
|
+
key?: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is
|
|
1714
|
+
* usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
|
|
1715
|
+
*/
|
|
1716
|
+
name: string;
|
|
1717
|
+
/** OAuth 2.0 token for the current user. */
|
|
1718
|
+
oauth_token?: string;
|
|
1719
|
+
/** Returns response with indentations and line breaks. */
|
|
1720
|
+
prettyPrint?: boolean;
|
|
1721
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1722
|
+
quotaUser?: string;
|
|
1723
|
+
/**
|
|
1724
|
+
* Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling
|
|
1725
|
+
* this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list
|
|
1726
|
+
* of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
|
|
1727
|
+
*/
|
|
1728
|
+
serviceAccountName?: string;
|
|
1729
|
+
/** Required. Required list of fields to be updated in this request. */
|
|
1730
|
+
updateMask?: string;
|
|
1731
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1732
|
+
upload_protocol?: string;
|
|
1733
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1734
|
+
uploadType?: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In
|
|
1737
|
+
* order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? client_id=client_id&scope=data_source_scopes
|
|
1738
|
+
* &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. *
|
|
1739
|
+
* data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
|
|
1740
|
+
*/
|
|
1741
|
+
versionInfo?: string;
|
|
1742
|
+
},
|
|
1743
|
+
body: TransferConfig): Request<TransferConfig>;
|
|
1744
|
+
/**
|
|
1745
|
+
* Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note
|
|
1746
|
+
* that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
|
|
1747
|
+
*/
|
|
1748
|
+
scheduleRuns(request: {
|
|
1749
|
+
/** V1 error format. */
|
|
1750
|
+
"$.xgafv"?: string;
|
|
1751
|
+
/** OAuth access token. */
|
|
1752
|
+
access_token?: string;
|
|
1753
|
+
/** Data format for response. */
|
|
1754
|
+
alt?: string;
|
|
1755
|
+
/** JSONP */
|
|
1756
|
+
callback?: string;
|
|
1757
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1758
|
+
fields?: string;
|
|
1759
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1760
|
+
key?: string;
|
|
1761
|
+
/** OAuth 2.0 token for the current user. */
|
|
1762
|
+
oauth_token?: string;
|
|
1763
|
+
/**
|
|
1764
|
+
* Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or
|
|
1765
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
|
1766
|
+
*/
|
|
1767
|
+
parent: string;
|
|
1768
|
+
/** Returns response with indentations and line breaks. */
|
|
1769
|
+
prettyPrint?: boolean;
|
|
1770
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1771
|
+
quotaUser?: string;
|
|
1772
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1773
|
+
upload_protocol?: string;
|
|
1774
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1775
|
+
uploadType?: string;
|
|
1776
|
+
/** Request body */
|
|
1777
|
+
resource: ScheduleTransferRunsRequest;
|
|
1778
|
+
}): Request<ScheduleTransferRunsResponse>;
|
|
1779
|
+
scheduleRuns(request: {
|
|
1780
|
+
/** V1 error format. */
|
|
1781
|
+
"$.xgafv"?: string;
|
|
1782
|
+
/** OAuth access token. */
|
|
1783
|
+
access_token?: string;
|
|
1784
|
+
/** Data format for response. */
|
|
1785
|
+
alt?: string;
|
|
1786
|
+
/** JSONP */
|
|
1787
|
+
callback?: string;
|
|
1788
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1789
|
+
fields?: string;
|
|
1790
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1791
|
+
key?: string;
|
|
1792
|
+
/** OAuth 2.0 token for the current user. */
|
|
1793
|
+
oauth_token?: string;
|
|
1794
|
+
/**
|
|
1795
|
+
* Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or
|
|
1796
|
+
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
|
1797
|
+
*/
|
|
1798
|
+
parent: string;
|
|
1799
|
+
/** Returns response with indentations and line breaks. */
|
|
1800
|
+
prettyPrint?: boolean;
|
|
1801
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1802
|
+
quotaUser?: string;
|
|
1803
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1804
|
+
upload_protocol?: string;
|
|
1805
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1806
|
+
uploadType?: string;
|
|
1807
|
+
},
|
|
1808
|
+
body: ScheduleTransferRunsRequest): Request<ScheduleTransferRunsResponse>;
|
|
1809
|
+
/**
|
|
1810
|
+
* Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time
|
|
1811
|
+
* (inclusive) and end_time (exclusive), or for a specific run_time.
|
|
1812
|
+
*/
|
|
1813
|
+
startManualRuns(request: {
|
|
1814
|
+
/** V1 error format. */
|
|
1815
|
+
"$.xgafv"?: string;
|
|
1816
|
+
/** OAuth access token. */
|
|
1817
|
+
access_token?: string;
|
|
1818
|
+
/** Data format for response. */
|
|
1819
|
+
alt?: string;
|
|
1820
|
+
/** JSONP */
|
|
1821
|
+
callback?: string;
|
|
1822
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1823
|
+
fields?: string;
|
|
1824
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1825
|
+
key?: string;
|
|
1826
|
+
/** OAuth 2.0 token for the current user. */
|
|
1827
|
+
oauth_token?: string;
|
|
1828
|
+
/** Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */
|
|
1829
|
+
parent: string;
|
|
1830
|
+
/** Returns response with indentations and line breaks. */
|
|
1831
|
+
prettyPrint?: boolean;
|
|
1832
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1833
|
+
quotaUser?: string;
|
|
1834
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1835
|
+
upload_protocol?: string;
|
|
1836
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1837
|
+
uploadType?: string;
|
|
1838
|
+
/** Request body */
|
|
1839
|
+
resource: StartManualTransferRunsRequest;
|
|
1840
|
+
}): Request<StartManualTransferRunsResponse>;
|
|
1841
|
+
startManualRuns(request: {
|
|
1842
|
+
/** V1 error format. */
|
|
1843
|
+
"$.xgafv"?: string;
|
|
1844
|
+
/** OAuth access token. */
|
|
1845
|
+
access_token?: string;
|
|
1846
|
+
/** Data format for response. */
|
|
1847
|
+
alt?: string;
|
|
1848
|
+
/** JSONP */
|
|
1849
|
+
callback?: string;
|
|
1850
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1851
|
+
fields?: string;
|
|
1852
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1853
|
+
key?: string;
|
|
1854
|
+
/** OAuth 2.0 token for the current user. */
|
|
1855
|
+
oauth_token?: string;
|
|
1856
|
+
/** Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */
|
|
1857
|
+
parent: string;
|
|
1858
|
+
/** Returns response with indentations and line breaks. */
|
|
1859
|
+
prettyPrint?: boolean;
|
|
1860
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1861
|
+
quotaUser?: string;
|
|
1862
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1863
|
+
upload_protocol?: string;
|
|
1864
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1865
|
+
uploadType?: string;
|
|
1866
|
+
},
|
|
1867
|
+
body: StartManualTransferRunsRequest): Request<StartManualTransferRunsResponse>;
|
|
1868
|
+
runs: RunsResource;
|
|
1869
|
+
}
|
|
1870
|
+
interface ProjectsResource {
|
|
1871
|
+
/**
|
|
1872
|
+
* Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will
|
|
1873
|
+
* appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web
|
|
1874
|
+
* UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
|
|
1875
|
+
*/
|
|
1876
|
+
enrollDataSources(request: {
|
|
1877
|
+
/** V1 error format. */
|
|
1878
|
+
"$.xgafv"?: string;
|
|
1879
|
+
/** OAuth access token. */
|
|
1880
|
+
access_token?: string;
|
|
1881
|
+
/** Data format for response. */
|
|
1882
|
+
alt?: string;
|
|
1883
|
+
/** JSONP */
|
|
1884
|
+
callback?: string;
|
|
1885
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1886
|
+
fields?: string;
|
|
1887
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1888
|
+
key?: string;
|
|
1889
|
+
/** The name of the project resource in the form: `projects/{project_id}` */
|
|
1890
|
+
name: string;
|
|
1891
|
+
/** OAuth 2.0 token for the current user. */
|
|
1892
|
+
oauth_token?: string;
|
|
1893
|
+
/** Returns response with indentations and line breaks. */
|
|
1894
|
+
prettyPrint?: boolean;
|
|
1895
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1896
|
+
quotaUser?: string;
|
|
1897
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1898
|
+
upload_protocol?: string;
|
|
1899
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1900
|
+
uploadType?: string;
|
|
1901
|
+
/** Request body */
|
|
1902
|
+
resource: EnrollDataSourcesRequest;
|
|
1903
|
+
}): Request<{}>;
|
|
1904
|
+
enrollDataSources(request: {
|
|
1905
|
+
/** V1 error format. */
|
|
1906
|
+
"$.xgafv"?: string;
|
|
1907
|
+
/** OAuth access token. */
|
|
1908
|
+
access_token?: string;
|
|
1909
|
+
/** Data format for response. */
|
|
1910
|
+
alt?: string;
|
|
1911
|
+
/** JSONP */
|
|
1912
|
+
callback?: string;
|
|
1913
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1914
|
+
fields?: string;
|
|
1915
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1916
|
+
key?: string;
|
|
1917
|
+
/** The name of the project resource in the form: `projects/{project_id}` */
|
|
1918
|
+
name: string;
|
|
1919
|
+
/** OAuth 2.0 token for the current user. */
|
|
1920
|
+
oauth_token?: string;
|
|
1921
|
+
/** Returns response with indentations and line breaks. */
|
|
1922
|
+
prettyPrint?: boolean;
|
|
1923
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1924
|
+
quotaUser?: string;
|
|
1925
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1926
|
+
upload_protocol?: string;
|
|
1927
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1928
|
+
uploadType?: string;
|
|
1929
|
+
},
|
|
1930
|
+
body: EnrollDataSourcesRequest): Request<{}>;
|
|
1931
|
+
dataSources: DataSourcesResource;
|
|
1932
|
+
locations: LocationsResource;
|
|
1933
|
+
transferConfigs: TransferConfigsResource;
|
|
1934
|
+
}
|
|
1935
|
+
|
|
1936
|
+
const projects: ProjectsResource;
|
|
1937
|
+
}
|
|
1938
|
+
}
|