Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(28)

Side by Side Diff: discovery/googleapis/bigquerydatatransfer__v1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/bigquery__v2.json ('k') | discovery/googleapis/calendar__v3.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/bigquery": {
6 "description": "View and manage your data in Google BigQuery "
7 },
8 "https://www.googleapis.com/auth/cloud-platform.read-only": { 5 "https://www.googleapis.com/auth/cloud-platform.read-only": {
9 "description": "View your data across Google Cloud Platform services" 6 "description": "View your data across Google Cloud Platform services"
10 }, 7 },
11 "https://www.googleapis.com/auth/cloud-platform": { 8 "https://www.googleapis.com/auth/cloud-platform": {
12 "description": "View and manage your data across Google Clou d Platform services" 9 "description": "View and manage your data across Google Clou d Platform services"
10 },
11 "https://www.googleapis.com/auth/bigquery": {
12 "description": "View and manage your data in Google BigQuery "
13 } 13 }
14 } 14 }
15 } 15 }
16 }, 16 },
17 "basePath": "", 17 "basePath": "",
18 "baseUrl": "https://bigquerydatatransfer.googleapis.com/", 18 "baseUrl": "https://bigquerydatatransfer.googleapis.com/",
19 "batchPath": "batch", 19 "batchPath": "batch",
20 "canonicalName": "BigQuery Data Transfer", 20 "canonicalName": "BigQuery Data Transfer",
21 "description": "Transfers data from partner SaaS applications to Google BigQ uery on a scheduled, managed basis.", 21 "description": "Transfers data from partner SaaS applications to Google BigQ uery on a scheduled, managed basis.",
22 "discoveryVersion": "v1", 22 "discoveryVersion": "v1",
23 "documentationLink": "https://cloud.google.com/bigquery/", 23 "documentationLink": "https://cloud.google.com/bigquery/",
24 "icons": { 24 "icons": {
25 "x16": "http://www.google.com/images/icons/product/search-16.gif", 25 "x16": "http://www.google.com/images/icons/product/search-16.gif",
26 "x32": "http://www.google.com/images/icons/product/search-32.gif" 26 "x32": "http://www.google.com/images/icons/product/search-32.gif"
27 }, 27 },
28 "id": "bigquerydatatransfer:v1", 28 "id": "bigquerydatatransfer:v1",
29 "kind": "discovery#restDescription", 29 "kind": "discovery#restDescription",
30 "name": "bigquerydatatransfer", 30 "name": "bigquerydatatransfer",
31 "ownerDomain": "google.com", 31 "ownerDomain": "google.com",
32 "ownerName": "Google", 32 "ownerName": "Google",
33 "parameters": { 33 "parameters": {
34 "key": {
35 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
36 "location": "query",
37 "type": "string"
38 },
39 "access_token": {
40 "description": "OAuth access token.",
41 "location": "query",
42 "type": "string"
43 },
44 "quotaUser": {
45 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
46 "location": "query",
47 "type": "string"
48 },
49 "pp": {
50 "default": "true",
51 "description": "Pretty-print response.",
52 "location": "query",
53 "type": "boolean"
54 },
55 "oauth_token": { 34 "oauth_token": {
56 "description": "OAuth 2.0 token for the current user.", 35 "description": "OAuth 2.0 token for the current user.",
57 "location": "query", 36 "location": "query",
58 "type": "string" 37 "type": "string"
59 }, 38 },
60 "bearer_token": { 39 "bearer_token": {
61 "description": "OAuth bearer token.", 40 "description": "OAuth bearer token.",
62 "location": "query", 41 "location": "query",
63 "type": "string" 42 "type": "string"
64 }, 43 },
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
109 "media", 88 "media",
110 "proto" 89 "proto"
111 ], 90 ],
112 "enumDescriptions": [ 91 "enumDescriptions": [
113 "Responses with Content-Type of application/json", 92 "Responses with Content-Type of application/json",
114 "Media download with context-dependent Content-Type", 93 "Media download with context-dependent Content-Type",
115 "Responses with Content-Type of application/x-protobuf" 94 "Responses with Content-Type of application/x-protobuf"
116 ], 95 ],
117 "location": "query", 96 "location": "query",
118 "type": "string" 97 "type": "string"
98 },
99 "key": {
100 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
101 "location": "query",
102 "type": "string"
103 },
104 "access_token": {
105 "description": "OAuth access token.",
106 "location": "query",
107 "type": "string"
108 },
109 "quotaUser": {
110 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
111 "location": "query",
112 "type": "string"
113 },
114 "pp": {
115 "default": "true",
116 "description": "Pretty-print response.",
117 "location": "query",
118 "type": "boolean"
119 } 119 }
120 }, 120 },
121 "protocol": "rest", 121 "protocol": "rest",
122 "resources": { 122 "resources": {
123 "projects": { 123 "projects": {
124 "methods": { 124 "methods": {
125 "setEnabled": { 125 "isEnabled": {
126 "description": "Enables or disables data transfer for a proj ect. This\nmethod requires the additional scope of\n'https://www.googleapis.com/ auth/cloudplatformprojects'\nto manage the cloud project permissions.", 126 "description": "Returns true if data transfer is enabled for a project.",
127 "httpMethod": "POST", 127 "httpMethod": "POST",
128 "id": "bigquerydatatransfer.projects.setEnabled", 128 "id": "bigquerydatatransfer.projects.isEnabled",
129 "parameterOrder": [ 129 "parameterOrder": [
130 "name" 130 "name"
131 ], 131 ],
132 "parameters": { 132 "parameters": {
133 "name": { 133 "name": {
134 "description": "The name of the project resource in the form:\n`projects/{project_id}`", 134 "description": "The name of the project resource in the form:\n`projects/{project_id}`",
135 "location": "path", 135 "location": "path",
136 "pattern": "^projects/[^/]+$", 136 "pattern": "^projects/[^/]+$",
137 "required": true, 137 "required": true,
138 "type": "string" 138 "type": "string"
139 } 139 }
140 }, 140 },
141 "path": "v1/{+name}:setEnabled", 141 "path": "v1/{+name}:isEnabled",
142 "request": { 142 "request": {
143 "$ref": "SetEnabledRequest" 143 "$ref": "IsEnabledRequest"
144 }, 144 },
145 "response": { 145 "response": {
146 "$ref": "Empty" 146 "$ref": "IsEnabledResponse"
147 }, 147 },
148 "scopes": [ 148 "scopes": [
149 "https://www.googleapis.com/auth/cloud-platform" 149 "https://www.googleapis.com/auth/bigquery",
150 "https://www.googleapis.com/auth/cloud-platform",
151 "https://www.googleapis.com/auth/cloud-platform.read-onl y"
150 ] 152 ]
151 }, 153 },
152 "isEnabled": { 154 "setEnabled": {
153 "description": "Returns true if data transfer is enabled for a project.", 155 "description": "Enables or disables data transfer for a proj ect. This\nmethod requires the additional scope of\n'https://www.googleapis.com/ auth/cloudplatformprojects'\nto manage the cloud project permissions.",
154 "httpMethod": "POST", 156 "httpMethod": "POST",
155 "id": "bigquerydatatransfer.projects.isEnabled", 157 "id": "bigquerydatatransfer.projects.setEnabled",
156 "parameterOrder": [ 158 "parameterOrder": [
157 "name" 159 "name"
158 ], 160 ],
159 "parameters": { 161 "parameters": {
160 "name": { 162 "name": {
161 "description": "The name of the project resource in the form:\n`projects/{project_id}`", 163 "description": "The name of the project resource in the form:\n`projects/{project_id}`",
162 "location": "path", 164 "location": "path",
163 "pattern": "^projects/[^/]+$", 165 "pattern": "^projects/[^/]+$",
164 "required": true, 166 "required": true,
165 "type": "string" 167 "type": "string"
166 } 168 }
167 }, 169 },
168 "path": "v1/{+name}:isEnabled", 170 "path": "v1/{+name}:setEnabled",
169 "request": { 171 "request": {
170 "$ref": "IsEnabledRequest" 172 "$ref": "SetEnabledRequest"
171 }, 173 },
172 "response": { 174 "response": {
173 "$ref": "IsEnabledResponse" 175 "$ref": "Empty"
174 }, 176 },
175 "scopes": [ 177 "scopes": [
176 "https://www.googleapis.com/auth/bigquery", 178 "https://www.googleapis.com/auth/cloud-platform"
177 "https://www.googleapis.com/auth/cloud-platform",
178 "https://www.googleapis.com/auth/cloud-platform.read-onl y"
179 ] 179 ]
180 } 180 }
181 }, 181 },
182 "resources": { 182 "resources": {
183 "locations": { 183 "locations": {
184 "methods": { 184 "methods": {
185 "isEnabled": { 185 "isEnabled": {
186 "description": "Returns true if data transfer is ena bled for a project.", 186 "description": "Returns true if data transfer is ena bled for a project.",
187 "httpMethod": "POST", 187 "httpMethod": "POST",
188 "id": "bigquerydatatransfer.projects.locations.isEna bled", 188 "id": "bigquerydatatransfer.projects.locations.isEna bled",
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
235 "$ref": "Empty" 235 "$ref": "Empty"
236 }, 236 },
237 "scopes": [ 237 "scopes": [
238 "https://www.googleapis.com/auth/cloud-platform" 238 "https://www.googleapis.com/auth/cloud-platform"
239 ] 239 ]
240 } 240 }
241 }, 241 },
242 "resources": { 242 "resources": {
243 "transferConfigs": { 243 "transferConfigs": {
244 "methods": { 244 "methods": {
245 "get": {
246 "description": "Returns information about a data transfer config.",
247 "httpMethod": "GET",
248 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.get",
249 "parameterOrder": [
250 "name"
251 ],
252 "parameters": {
253 "name": {
254 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}`",
255 "location": "path",
256 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
257 "required": true,
258 "type": "string"
259 }
260 },
261 "path": "v1/{+name}",
262 "response": {
263 "$ref": "TransferConfig"
264 },
265 "scopes": [
266 "https://www.googleapis.com/auth/bigquer y",
267 "https://www.googleapis.com/auth/cloud-p latform",
268 "https://www.googleapis.com/auth/cloud-p latform.read-only"
269 ]
270 },
271 "patch": {
272 "description": "Updates a data transfer conf iguration.\nAll fields must be set, even if they are not updated.",
273 "httpMethod": "PATCH",
274 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.patch",
275 "parameterOrder": [
276 "name"
277 ],
278 "parameters": {
279 "authorizationCode": {
280 "description": "Optional OAuth2 auth orization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing u ser.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps:// www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclien tid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id shoul d be OAuth client_id of BigQuery DTS API for the given\n data source returned b y ListDataSources method.\n* data_source_scopes are the scopes returned by ListD ataSources method.\n* redirect_uri is an optional parameter. If not specified, t hen\n authorization code is posted to the opener of authorization flow window.\ n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf :wg:oauth:2.0:oob means that authorization code should be\n returned in the tit le bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
281 "location": "query",
282 "type": "string"
283 },
284 "updateMask": {
285 "description": "Required list of fie lds to be updated in this request.",
286 "format": "google-fieldmask",
287 "location": "query",
288 "type": "string"
289 },
290 "name": {
291 "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/tra nsferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run .",
292 "location": "path",
293 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
294 "required": true,
295 "type": "string"
296 }
297 },
298 "path": "v1/{+name}",
299 "request": {
300 "$ref": "TransferConfig"
301 },
302 "response": {
303 "$ref": "TransferConfig"
304 },
305 "scopes": [
306 "https://www.googleapis.com/auth/bigquer y",
307 "https://www.googleapis.com/auth/cloud-p latform"
308 ]
309 },
310 "delete": { 245 "delete": {
311 "description": "Deletes a data transfer conf iguration,\nincluding any associated transfer runs and logs.", 246 "description": "Deletes a data transfer conf iguration,\nincluding any associated transfer runs and logs.",
312 "httpMethod": "DELETE", 247 "httpMethod": "DELETE",
313 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.delete", 248 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.delete",
314 "parameterOrder": [ 249 "parameterOrder": [
315 "name" 250 "name"
316 ], 251 ],
317 "parameters": { 252 "parameters": {
318 "name": { 253 "name": {
319 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}`", 254 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}`",
(...skipping 13 matching lines...) Expand all
333 ] 268 ]
334 }, 269 },
335 "list": { 270 "list": {
336 "description": "Returns information about al l data transfers in the project.", 271 "description": "Returns information about al l data transfers in the project.",
337 "httpMethod": "GET", 272 "httpMethod": "GET",
338 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.list", 273 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.list",
339 "parameterOrder": [ 274 "parameterOrder": [
340 "parent" 275 "parent"
341 ], 276 ],
342 "parameters": { 277 "parameters": {
278 "pageToken": {
279 "description": "Pagination token, wh ich can be used to request a specific page\nof `ListTransfersRequest` list resul ts. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` t oken, which can be used as the\n`page_token` value to request the next page of l ist results.",
280 "location": "query",
281 "type": "string"
282 },
283 "pageSize": {
284 "description": "Page size. The defau lt page size is the maximum value of 1000 results.",
285 "format": "int32",
286 "location": "query",
287 "type": "integer"
288 },
343 "dataSourceIds": { 289 "dataSourceIds": {
344 "description": "When specified, only configurations of requested data sources are returned.", 290 "description": "When specified, only configurations of requested data sources are returned.",
345 "location": "query", 291 "location": "query",
346 "repeated": true, 292 "repeated": true,
347 "type": "string" 293 "type": "string"
348 }, 294 },
349 "parent": { 295 "parent": {
350 "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.", 296 "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
351 "location": "path", 297 "location": "path",
352 "pattern": "^projects/[^/]+/location s/[^/]+$", 298 "pattern": "^projects/[^/]+/location s/[^/]+$",
353 "required": true, 299 "required": true,
354 "type": "string" 300 "type": "string"
355 },
356 "pageToken": {
357 "description": "Pagination token, wh ich can be used to request a specific page\nof `ListTransfersRequest` list resul ts. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` t oken, which can be used as the\n`page_token` value to request the next page of l ist results.",
358 "location": "query",
359 "type": "string"
360 },
361 "pageSize": {
362 "description": "Page size. The defau lt page size is the maximum value of 1000 results.",
363 "format": "int32",
364 "location": "query",
365 "type": "integer"
366 } 301 }
367 }, 302 },
368 "path": "v1/{+parent}/transferConfigs", 303 "path": "v1/{+parent}/transferConfigs",
369 "response": { 304 "response": {
370 "$ref": "ListTransferConfigsResponse" 305 "$ref": "ListTransferConfigsResponse"
371 }, 306 },
372 "scopes": [ 307 "scopes": [
373 "https://www.googleapis.com/auth/bigquer y", 308 "https://www.googleapis.com/auth/bigquer y",
374 "https://www.googleapis.com/auth/cloud-p latform", 309 "https://www.googleapis.com/auth/cloud-p latform",
375 "https://www.googleapis.com/auth/cloud-p latform.read-only" 310 "https://www.googleapis.com/auth/cloud-p latform.read-only"
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after
428 "request": { 363 "request": {
429 "$ref": "ScheduleTransferRunsRequest" 364 "$ref": "ScheduleTransferRunsRequest"
430 }, 365 },
431 "response": { 366 "response": {
432 "$ref": "ScheduleTransferRunsResponse" 367 "$ref": "ScheduleTransferRunsResponse"
433 }, 368 },
434 "scopes": [ 369 "scopes": [
435 "https://www.googleapis.com/auth/bigquer y", 370 "https://www.googleapis.com/auth/bigquer y",
436 "https://www.googleapis.com/auth/cloud-p latform" 371 "https://www.googleapis.com/auth/cloud-p latform"
437 ] 372 ]
373 },
374 "patch": {
375 "description": "Updates a data transfer conf iguration.\nAll fields must be set, even if they are not updated.",
376 "httpMethod": "PATCH",
377 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.patch",
378 "parameterOrder": [
379 "name"
380 ],
381 "parameters": {
382 "updateMask": {
383 "description": "Required list of fie lds to be updated in this request.",
384 "format": "google-fieldmask",
385 "location": "query",
386 "type": "string"
387 },
388 "name": {
389 "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/tra nsferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run .",
390 "location": "path",
391 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
392 "required": true,
393 "type": "string"
394 },
395 "authorizationCode": {
396 "description": "Optional OAuth2 auth orization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing u ser.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps:// www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclien tid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id shoul d be OAuth client_id of BigQuery DTS API for the given\n data source returned b y ListDataSources method.\n* data_source_scopes are the scopes returned by ListD ataSources method.\n* redirect_uri is an optional parameter. If not specified, t hen\n authorization code is posted to the opener of authorization flow window.\ n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf :wg:oauth:2.0:oob means that authorization code should be\n returned in the tit le bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
397 "location": "query",
398 "type": "string"
399 }
400 },
401 "path": "v1/{+name}",
402 "request": {
403 "$ref": "TransferConfig"
404 },
405 "response": {
406 "$ref": "TransferConfig"
407 },
408 "scopes": [
409 "https://www.googleapis.com/auth/bigquer y",
410 "https://www.googleapis.com/auth/cloud-p latform"
411 ]
412 },
413 "get": {
414 "description": "Returns information about a data transfer config.",
415 "httpMethod": "GET",
416 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.get",
417 "parameterOrder": [
418 "name"
419 ],
420 "parameters": {
421 "name": {
422 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}`",
423 "location": "path",
424 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
425 "required": true,
426 "type": "string"
427 }
428 },
429 "path": "v1/{+name}",
430 "response": {
431 "$ref": "TransferConfig"
432 },
433 "scopes": [
434 "https://www.googleapis.com/auth/bigquer y",
435 "https://www.googleapis.com/auth/cloud-p latform",
436 "https://www.googleapis.com/auth/cloud-p latform.read-only"
437 ]
438 } 438 }
439 }, 439 },
440 "resources": { 440 "resources": {
441 "runs": { 441 "runs": {
442 "methods": { 442 "methods": {
443 "delete": { 443 "delete": {
444 "description": "Deletes the specifie d transfer run.", 444 "description": "Deletes the specifie d transfer run.",
445 "httpMethod": "DELETE", 445 "httpMethod": "DELETE",
446 "id": "bigquerydatatransfer.projects .locations.transferConfigs.runs.delete", 446 "id": "bigquerydatatransfer.projects .locations.transferConfigs.runs.delete",
447 "parameterOrder": [ 447 "parameterOrder": [
(...skipping 109 matching lines...) Expand 10 before | Expand all | Expand 10 after
557 "transferLogs": { 557 "transferLogs": {
558 "methods": { 558 "methods": {
559 "list": { 559 "list": {
560 "description": "Returns user facing log messages for the data transfer run.", 560 "description": "Returns user facing log messages for the data transfer run.",
561 "httpMethod": "GET", 561 "httpMethod": "GET",
562 "id": "bigquerydatatransfer. projects.locations.transferConfigs.runs.transferLogs.list", 562 "id": "bigquerydatatransfer. projects.locations.transferConfigs.runs.transferLogs.list",
563 "parameterOrder": [ 563 "parameterOrder": [
564 "parent" 564 "parent"
565 ], 565 ],
566 "parameters": { 566 "parameters": {
567 "pageSize": {
568 "description": "Page size. The default page size is the maximum value of 1000 results.",
569 "format": "int32",
570 "location": "query",
571 "type": "integer"
572 },
567 "messageTypes": { 573 "messageTypes": {
568 "description": "Mess age types to return. If not populated - INFO, WARNING and ERROR\nmessages are re turned.", 574 "description": "Mess age types to return. If not populated - INFO, WARNING and ERROR\nmessages are re turned.",
569 "enum": [ 575 "enum": [
570 "MESSAGE_SEVERIT Y_UNSPECIFIED", 576 "MESSAGE_SEVERIT Y_UNSPECIFIED",
571 "INFO", 577 "INFO",
572 "WARNING", 578 "WARNING",
573 "ERROR" 579 "ERROR"
574 ], 580 ],
575 "location": "query", 581 "location": "query",
576 "repeated": true, 582 "repeated": true,
577 "type": "string" 583 "type": "string"
578 }, 584 },
579 "parent": { 585 "parent": {
580 "description": "Tran sfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/r uns/{run_id}`.", 586 "description": "Tran sfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/r uns/{run_id}`.",
581 "location": "path", 587 "location": "path",
582 "pattern": "^project s/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", 588 "pattern": "^project s/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
583 "required": true, 589 "required": true,
584 "type": "string" 590 "type": "string"
585 }, 591 },
586 "pageToken": { 592 "pageToken": {
587 "description": "Pagi nation token, which can be used to request a specific page\nof `ListTransferLogs Request` list results. For multiple-page\nresults, `ListTransferLogsResponse` ou tputs\na `next_page` token, which can be used as the\n`page_token` value to requ est the next page of list results.", 593 "description": "Pagi nation token, which can be used to request a specific page\nof `ListTransferLogs Request` list results. For multiple-page\nresults, `ListTransferLogsResponse` ou tputs\na `next_page` token, which can be used as the\n`page_token` value to requ est the next page of list results.",
588 "location": "query", 594 "location": "query",
589 "type": "string" 595 "type": "string"
590 },
591 "pageSize": {
592 "description": "Page size. The default page size is the maximum value of 1000 results.",
593 "format": "int32",
594 "location": "query",
595 "type": "integer"
596 } 596 }
597 }, 597 },
598 "path": "v1/{+parent}/transf erLogs", 598 "path": "v1/{+parent}/transf erLogs",
599 "response": { 599 "response": {
600 "$ref": "ListTransferLog sResponse" 600 "$ref": "ListTransferLog sResponse"
601 }, 601 },
602 "scopes": [ 602 "scopes": [
603 "https://www.googleapis. com/auth/bigquery", 603 "https://www.googleapis. com/auth/bigquery",
604 "https://www.googleapis. com/auth/cloud-platform", 604 "https://www.googleapis. com/auth/cloud-platform",
605 "https://www.googleapis. com/auth/cloud-platform.read-only" 605 "https://www.googleapis. com/auth/cloud-platform.read-only"
(...skipping 131 matching lines...) Expand 10 before | Expand all | Expand 10 after
737 ] 737 ]
738 }, 738 },
739 "list": { 739 "list": {
740 "description": "Returns information about all data t ransfers in the project.", 740 "description": "Returns information about all data t ransfers in the project.",
741 "httpMethod": "GET", 741 "httpMethod": "GET",
742 "id": "bigquerydatatransfer.projects.transferConfigs .list", 742 "id": "bigquerydatatransfer.projects.transferConfigs .list",
743 "parameterOrder": [ 743 "parameterOrder": [
744 "parent" 744 "parent"
745 ], 745 ],
746 "parameters": { 746 "parameters": {
747 "pageSize": {
748 "description": "Page size. The default page size is the maximum value of 1000 results.",
749 "format": "int32",
750 "location": "query",
751 "type": "integer"
752 },
747 "dataSourceIds": { 753 "dataSourceIds": {
748 "description": "When specified, only configu rations of requested data sources are returned.", 754 "description": "When specified, only configu rations of requested data sources are returned.",
749 "location": "query", 755 "location": "query",
750 "repeated": true, 756 "repeated": true,
751 "type": "string" 757 "type": "string"
752 }, 758 },
753 "parent": { 759 "parent": {
754 "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.", 760 "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
755 "location": "path", 761 "location": "path",
756 "pattern": "^projects/[^/]+$", 762 "pattern": "^projects/[^/]+$",
757 "required": true, 763 "required": true,
758 "type": "string" 764 "type": "string"
759 }, 765 },
760 "pageToken": { 766 "pageToken": {
761 "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, wh ich can be used as the\n`page_token` value to request the next page of list resu lts.", 767 "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, wh ich can be used as the\n`page_token` value to request the next page of list resu lts.",
762 "location": "query", 768 "location": "query",
763 "type": "string" 769 "type": "string"
764 },
765 "pageSize": {
766 "description": "Page size. The default page size is the maximum value of 1000 results.",
767 "format": "int32",
768 "location": "query",
769 "type": "integer"
770 } 770 }
771 }, 771 },
772 "path": "v1/{+parent}/transferConfigs", 772 "path": "v1/{+parent}/transferConfigs",
773 "response": { 773 "response": {
774 "$ref": "ListTransferConfigsResponse" 774 "$ref": "ListTransferConfigsResponse"
775 }, 775 },
776 "scopes": [ 776 "scopes": [
777 "https://www.googleapis.com/auth/bigquery", 777 "https://www.googleapis.com/auth/bigquery",
778 "https://www.googleapis.com/auth/cloud-platform" , 778 "https://www.googleapis.com/auth/cloud-platform" ,
779 "https://www.googleapis.com/auth/cloud-platform. read-only" 779 "https://www.googleapis.com/auth/cloud-platform. read-only"
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after
833 "$ref": "ScheduleTransferRunsRequest" 833 "$ref": "ScheduleTransferRunsRequest"
834 }, 834 },
835 "response": { 835 "response": {
836 "$ref": "ScheduleTransferRunsResponse" 836 "$ref": "ScheduleTransferRunsResponse"
837 }, 837 },
838 "scopes": [ 838 "scopes": [
839 "https://www.googleapis.com/auth/bigquery", 839 "https://www.googleapis.com/auth/bigquery",
840 "https://www.googleapis.com/auth/cloud-platform" 840 "https://www.googleapis.com/auth/cloud-platform"
841 ] 841 ]
842 }, 842 },
843 "patch": {
844 "description": "Updates a data transfer configuratio n.\nAll fields must be set, even if they are not updated.",
845 "httpMethod": "PATCH",
846 "id": "bigquerydatatransfer.projects.transferConfigs .patch",
847 "parameterOrder": [
848 "name"
849 ],
850 "parameters": {
851 "name": {
852 "description": "The resource name of the tra nsfer run.\nTransfer run names have the form\n`projects/{project_id}/transferCon figs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\n guaranteed or required. The name is ignored when creating a transfer run.",
853 "location": "path",
854 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
855 "required": true,
856 "type": "string"
857 },
858 "authorizationCode": {
859 "description": "Optional OAuth2 authorizatio n code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gsta tic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&sco pe=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAu th client_id of BigQuery DTS API for the given\n data source returned by ListDa taSources method.\n* data_source_scopes are the scopes returned by ListDataSourc es method.\n* redirect_uri is an optional parameter. If not specified, then\n a uthorization code is posted to the opener of authorization flow window.\n Other wise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oaut h:2.0:oob means that authorization code should be\n returned in the title bar o f the browser, with the page text prompting\n the user to copy the code and pas te it in the application.",
860 "location": "query",
861 "type": "string"
862 },
863 "updateMask": {
864 "description": "Required list of fields to b e updated in this request.",
865 "format": "google-fieldmask",
866 "location": "query",
867 "type": "string"
868 }
869 },
870 "path": "v1/{+name}",
871 "request": {
872 "$ref": "TransferConfig"
873 },
874 "response": {
875 "$ref": "TransferConfig"
876 },
877 "scopes": [
878 "https://www.googleapis.com/auth/bigquery",
879 "https://www.googleapis.com/auth/cloud-platform"
880 ]
881 },
882 "get": { 843 "get": {
883 "description": "Returns information about a data tra nsfer config.", 844 "description": "Returns information about a data tra nsfer config.",
884 "httpMethod": "GET", 845 "httpMethod": "GET",
885 "id": "bigquerydatatransfer.projects.transferConfigs .get", 846 "id": "bigquerydatatransfer.projects.transferConfigs .get",
886 "parameterOrder": [ 847 "parameterOrder": [
887 "name" 848 "name"
888 ], 849 ],
889 "parameters": { 850 "parameters": {
890 "name": { 851 "name": {
891 "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/ {config_id}`", 852 "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/ {config_id}`",
892 "location": "path", 853 "location": "path",
893 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$", 854 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
894 "required": true, 855 "required": true,
856 "type": "string"
857 }
858 },
859 "path": "v1/{+name}",
860 "response": {
861 "$ref": "TransferConfig"
862 },
863 "scopes": [
864 "https://www.googleapis.com/auth/bigquery",
865 "https://www.googleapis.com/auth/cloud-platform" ,
866 "https://www.googleapis.com/auth/cloud-platform. read-only"
867 ]
868 },
869 "patch": {
870 "description": "Updates a data transfer configuratio n.\nAll fields must be set, even if they are not updated.",
871 "httpMethod": "PATCH",
872 "id": "bigquerydatatransfer.projects.transferConfigs .patch",
873 "parameterOrder": [
874 "name"
875 ],
876 "parameters": {
877 "authorizationCode": {
878 "description": "Optional OAuth2 authorizatio n code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gsta tic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&sco pe=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAu th client_id of BigQuery DTS API for the given\n data source returned by ListDa taSources method.\n* data_source_scopes are the scopes returned by ListDataSourc es method.\n* redirect_uri is an optional parameter. If not specified, then\n a uthorization code is posted to the opener of authorization flow window.\n Other wise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oaut h:2.0:oob means that authorization code should be\n returned in the title bar o f the browser, with the page text prompting\n the user to copy the code and pas te it in the application.",
879 "location": "query",
880 "type": "string"
881 },
882 "updateMask": {
883 "description": "Required list of fields to b e updated in this request.",
884 "format": "google-fieldmask",
885 "location": "query",
886 "type": "string"
887 },
888 "name": {
889 "description": "The resource name of the tra nsfer run.\nTransfer run names have the form\n`projects/{project_id}/transferCon figs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\n guaranteed or required. The name is ignored when creating a transfer run.",
890 "location": "path",
891 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
892 "required": true,
895 "type": "string" 893 "type": "string"
896 } 894 }
897 }, 895 },
898 "path": "v1/{+name}", 896 "path": "v1/{+name}",
897 "request": {
898 "$ref": "TransferConfig"
899 },
899 "response": { 900 "response": {
900 "$ref": "TransferConfig" 901 "$ref": "TransferConfig"
901 }, 902 },
902 "scopes": [ 903 "scopes": [
903 "https://www.googleapis.com/auth/bigquery", 904 "https://www.googleapis.com/auth/bigquery",
904 "https://www.googleapis.com/auth/cloud-platform" , 905 "https://www.googleapis.com/auth/cloud-platform"
905 "https://www.googleapis.com/auth/cloud-platform. read-only"
906 ] 906 ]
907 } 907 }
908 }, 908 },
909 "resources": { 909 "resources": {
910 "runs": { 910 "runs": {
911 "methods": { 911 "methods": {
912 "delete": {
913 "description": "Deletes the specified transf er run.",
914 "httpMethod": "DELETE",
915 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.delete",
916 "parameterOrder": [
917 "name"
918 ],
919 "parameters": {
920 "name": {
921 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}/runs/{run_id}`",
922 "location": "path",
923 "pattern": "^projects/[^/]+/transfer Configs/[^/]+/runs/[^/]+$",
924 "required": true,
925 "type": "string"
926 }
927 },
928 "path": "v1/{+name}",
929 "response": {
930 "$ref": "Empty"
931 },
932 "scopes": [
933 "https://www.googleapis.com/auth/bigquer y",
934 "https://www.googleapis.com/auth/cloud-p latform"
935 ]
936 },
937 "list": { 912 "list": {
938 "description": "Returns information about ru nning and completed jobs.", 913 "description": "Returns information about ru nning and completed jobs.",
939 "httpMethod": "GET", 914 "httpMethod": "GET",
940 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.list", 915 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.list",
941 "parameterOrder": [ 916 "parameterOrder": [
942 "parent" 917 "parent"
943 ], 918 ],
944 "parameters": { 919 "parameters": {
945 "runAttempt": {
946 "description": "Indicates how run at tempts are to be pulled.",
947 "enum": [
948 "RUN_ATTEMPT_UNSPECIFIED",
949 "LATEST"
950 ],
951 "location": "query",
952 "type": "string"
953 },
954 "parent": {
955 "description": "Name of transfer con figuration for which transfer runs should be retrieved.\nFormat of transfer conf iguration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}` .",
956 "location": "path",
957 "pattern": "^projects/[^/]+/transfer Configs/[^/]+$",
958 "required": true,
959 "type": "string"
960 },
961 "pageToken": { 920 "pageToken": {
962 "description": "Pagination token, wh ich can be used to request a specific page\nof `ListTransferRunsRequest` list re sults. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_p age` token, which can be used as the\n`page_token` value to request the next pag e of list results.", 921 "description": "Pagination token, wh ich can be used to request a specific page\nof `ListTransferRunsRequest` list re sults. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_p age` token, which can be used as the\n`page_token` value to request the next pag e of list results.",
963 "location": "query", 922 "location": "query",
964 "type": "string" 923 "type": "string"
965 }, 924 },
966 "pageSize": { 925 "pageSize": {
967 "description": "Page size. The defau lt page size is the maximum value of 1000 results.", 926 "description": "Page size. The defau lt page size is the maximum value of 1000 results.",
968 "format": "int32", 927 "format": "int32",
969 "location": "query", 928 "location": "query",
970 "type": "integer" 929 "type": "integer"
971 }, 930 },
972 "statuses": { 931 "statuses": {
973 "description": "When specified, only transfer runs with requested statuses are returned.", 932 "description": "When specified, only transfer runs with requested statuses are returned.",
974 "enum": [ 933 "enum": [
975 "TRANSFER_STATUS_UNSPECIFIED", 934 "TRANSFER_STATUS_UNSPECIFIED",
976 "INACTIVE", 935 "INACTIVE",
977 "PENDING", 936 "PENDING",
978 "RUNNING", 937 "RUNNING",
979 "SUCCEEDED", 938 "SUCCEEDED",
980 "FAILED", 939 "FAILED",
981 "CANCELLED" 940 "CANCELLED"
982 ], 941 ],
983 "location": "query", 942 "location": "query",
984 "repeated": true, 943 "repeated": true,
985 "type": "string" 944 "type": "string"
945 },
946 "runAttempt": {
947 "description": "Indicates how run at tempts are to be pulled.",
948 "enum": [
949 "RUN_ATTEMPT_UNSPECIFIED",
950 "LATEST"
951 ],
952 "location": "query",
953 "type": "string"
954 },
955 "parent": {
956 "description": "Name of transfer con figuration for which transfer runs should be retrieved.\nFormat of transfer conf iguration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}` .",
957 "location": "path",
958 "pattern": "^projects/[^/]+/transfer Configs/[^/]+$",
959 "required": true,
960 "type": "string"
986 } 961 }
987 }, 962 },
988 "path": "v1/{+parent}/runs", 963 "path": "v1/{+parent}/runs",
989 "response": { 964 "response": {
990 "$ref": "ListTransferRunsResponse" 965 "$ref": "ListTransferRunsResponse"
991 }, 966 },
992 "scopes": [ 967 "scopes": [
993 "https://www.googleapis.com/auth/bigquer y", 968 "https://www.googleapis.com/auth/bigquer y",
994 "https://www.googleapis.com/auth/cloud-p latform", 969 "https://www.googleapis.com/auth/cloud-p latform",
995 "https://www.googleapis.com/auth/cloud-p latform.read-only" 970 "https://www.googleapis.com/auth/cloud-p latform.read-only"
(...skipping 17 matching lines...) Expand all
1013 }, 988 },
1014 "path": "v1/{+name}", 989 "path": "v1/{+name}",
1015 "response": { 990 "response": {
1016 "$ref": "TransferRun" 991 "$ref": "TransferRun"
1017 }, 992 },
1018 "scopes": [ 993 "scopes": [
1019 "https://www.googleapis.com/auth/bigquer y", 994 "https://www.googleapis.com/auth/bigquer y",
1020 "https://www.googleapis.com/auth/cloud-p latform", 995 "https://www.googleapis.com/auth/cloud-p latform",
1021 "https://www.googleapis.com/auth/cloud-p latform.read-only" 996 "https://www.googleapis.com/auth/cloud-p latform.read-only"
1022 ] 997 ]
998 },
999 "delete": {
1000 "description": "Deletes the specified transf er run.",
1001 "httpMethod": "DELETE",
1002 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.delete",
1003 "parameterOrder": [
1004 "name"
1005 ],
1006 "parameters": {
1007 "name": {
1008 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}/runs/{run_id}`",
1009 "location": "path",
1010 "pattern": "^projects/[^/]+/transfer Configs/[^/]+/runs/[^/]+$",
1011 "required": true,
1012 "type": "string"
1013 }
1014 },
1015 "path": "v1/{+name}",
1016 "response": {
1017 "$ref": "Empty"
1018 },
1019 "scopes": [
1020 "https://www.googleapis.com/auth/bigquer y",
1021 "https://www.googleapis.com/auth/cloud-p latform"
1022 ]
1023 } 1023 }
1024 }, 1024 },
1025 "resources": { 1025 "resources": {
1026 "transferLogs": { 1026 "transferLogs": {
1027 "methods": { 1027 "methods": {
1028 "list": { 1028 "list": {
1029 "description": "Returns user facing log messages for the data transfer run.", 1029 "description": "Returns user facing log messages for the data transfer run.",
1030 "httpMethod": "GET", 1030 "httpMethod": "GET",
1031 "id": "bigquerydatatransfer.projects .transferConfigs.runs.transferLogs.list", 1031 "id": "bigquerydatatransfer.projects .transferConfigs.runs.transferLogs.list",
1032 "parameterOrder": [ 1032 "parameterOrder": [
(...skipping 139 matching lines...) Expand 10 before | Expand all | Expand 10 after
1172 "https://www.googleapis.com/auth/bigquery", 1172 "https://www.googleapis.com/auth/bigquery",
1173 "https://www.googleapis.com/auth/cloud-platform" , 1173 "https://www.googleapis.com/auth/cloud-platform" ,
1174 "https://www.googleapis.com/auth/cloud-platform. read-only" 1174 "https://www.googleapis.com/auth/cloud-platform. read-only"
1175 ] 1175 ]
1176 } 1176 }
1177 } 1177 }
1178 } 1178 }
1179 } 1179 }
1180 } 1180 }
1181 }, 1181 },
1182 "revision": "20170703", 1182 "revision": "20170724",
1183 "rootUrl": "https://bigquerydatatransfer.googleapis.com/", 1183 "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
1184 "schemas": { 1184 "schemas": {
1185 "DataSource": {
1186 "description": "Represents data source metadata. Metadata is suffici ent to\nrender UI and request proper OAuth tokens.",
1187 "id": "DataSource",
1188 "properties": {
1189 "name": {
1190 "description": "Data source resource name.",
1191 "type": "string"
1192 },
1193 "scopes": {
1194 "description": "Api auth scopes for which refresh token need s to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into B igQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
1195 "items": {
1196 "type": "string"
1197 },
1198 "type": "array"
1199 },
1200 "clientId": {
1201 "description": "Data source client id which should be used t o receive refresh token.\nWhen not supplied, no offline credentials are populate d for data transfer.",
1202 "type": "string"
1203 },
1204 "authorizationType": {
1205 "description": "Indicates the type of authorization.",
1206 "enum": [
1207 "AUTHORIZATION_TYPE_UNSPECIFIED",
1208 "AUTHORIZATION_CODE",
1209 "GOOGLE_PLUS_AUTHORIZATION_CODE"
1210 ],
1211 "enumDescriptions": [
1212 "Type unspecified.",
1213 "Use OAuth 2 authorization codes that can be exchanged\n for a refresh token on the backend.",
1214 "Return an authorization code for a given Google+ page t hat can then be\nexchanged for a refresh token on the backend."
1215 ],
1216 "type": "string"
1217 },
1218 "supportsCustomSchedule": {
1219 "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true `, user can override default schedule.",
1220 "type": "boolean"
1221 },
1222 "displayName": {
1223 "description": "User friendly data source name.",
1224 "type": "string"
1225 },
1226 "dataRefreshType": {
1227 "description": "Specifies whether the data source supports a utomatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
1228 "enum": [
1229 "NONE",
1230 "SLIDING_WINDOW",
1231 "CUSTOM_SLIDING_WINDOW"
1232 ],
1233 "enumDescriptions": [
1234 "The data source won't support data auto refresh, which is default value.",
1235 "The data source supports data auto refresh, and runs wi ll be scheduled\nfor the past few days. Does not allow custom values to be set f or each\ntransfer config.",
1236 "The data source supports data auto refresh, and runs wi ll be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
1237 ],
1238 "type": "string"
1239 },
1240 "parameters": {
1241 "description": "Data source parameters.",
1242 "items": {
1243 "$ref": "DataSourceParameter"
1244 },
1245 "type": "array"
1246 },
1247 "helpUrl": {
1248 "description": "Url for the help document for this data sour ce.",
1249 "type": "string"
1250 },
1251 "defaultSchedule": {
1252 "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of j an,jun 13:15`, and\n`first sunday of quarter 00:00`.",
1253 "type": "string"
1254 },
1255 "supportsMultipleTransfers": {
1256 "description": "Indicates whether the data source supports m ultiple transfers\nto different BigQuery targets.",
1257 "type": "boolean"
1258 },
1259 "statusUpdateDeadlineSeconds": {
1260 "description": "The number of seconds to wait for a status u pdate from the data source\nbefore BigQuery marks the transfer as failed.",
1261 "format": "int32",
1262 "type": "integer"
1263 },
1264 "manualRunsDisabled": {
1265 "description": "Disables backfilling and manual run scheduli ng\nfor the data source.",
1266 "type": "boolean"
1267 },
1268 "defaultDataRefreshWindowDays": {
1269 "description": "Default data refresh window on days.\nOnly m eaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
1270 "format": "int32",
1271 "type": "integer"
1272 },
1273 "transferType": {
1274 "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquer y) to ingest the data.",
1275 "enum": [
1276 "TRANSFER_TYPE_UNSPECIFIED",
1277 "BATCH",
1278 "STREAMING"
1279 ],
1280 "enumDescriptions": [
1281 "Invalid or Unknown transfer type placeholder.",
1282 "Batch data transfer.",
1283 "Streaming data transfer. Streaming data source currentl y doesn't\nsupport multiple transfer configs per project."
1284 ],
1285 "type": "string"
1286 },
1287 "description": {
1288 "description": "User friendly data source description string .",
1289 "type": "string"
1290 },
1291 "dataSourceId": {
1292 "description": "Data source id.",
1293 "type": "string"
1294 }
1295 },
1296 "type": "object"
1297 },
1298 "ScheduleTransferRunsRequest": {
1299 "description": "A request to schedule transfer runs for a time range .",
1300 "id": "ScheduleTransferRunsRequest",
1301 "properties": {
1302 "rangeStartTime": {
1303 "description": "Start time of the range of transfer runs.",
1304 "format": "google-datetime",
1305 "type": "string"
1306 },
1307 "rangeEndTime": {
1308 "description": "End time of the range of transfer runs.",
1309 "format": "google-datetime",
1310 "type": "string"
1311 }
1312 },
1313 "type": "object"
1314 },
1315 "Empty": {
1316 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
1317 "id": "Empty",
1318 "properties": {},
1319 "type": "object"
1320 },
1321 "TransferConfig": { 1185 "TransferConfig": {
1322 "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For exa mple,\n`destination_dataset_id` specifies where data should be stored.\nWhen a n ew transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service accoun t.", 1186 "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For exa mple,\n`destination_dataset_id` specifies where data should be stored.\nWhen a n ew transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service accoun t.",
1323 "id": "TransferConfig", 1187 "id": "TransferConfig",
1324 "properties": { 1188 "properties": {
1325 "datasetRegion": {
1326 "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
1327 "type": "string"
1328 },
1329 "displayName": { 1189 "displayName": {
1330 "description": "User specified display name for the data tra nsfer.", 1190 "description": "User specified display name for the data tra nsfer.",
1331 "type": "string" 1191 "type": "string"
1332 }, 1192 },
1333 "nextRunTime": { 1193 "nextRunTime": {
1334 "description": "Next time when data transfer will run. Outpu t only. Applicable\nonly for batch data transfers.\n@OutputOnly", 1194 "description": "Next time when data transfer will run. Outpu t only. Applicable\nonly for batch data transfers.\n@OutputOnly",
1335 "format": "google-datetime", 1195 "format": "google-datetime",
1336 "type": "string" 1196 "type": "string"
1337 }, 1197 },
1338 "disabled": { 1198 "disabled": {
1339 "description": "Is this config disabled. When set to true, n o runs are scheduled\nfor a given transfer.", 1199 "description": "Is this config disabled. When set to true, n o runs are scheduled\nfor a given transfer.",
1340 "type": "boolean" 1200 "type": "boolean"
1341 }, 1201 },
1342 "schedule": {
1343 "description": "Data transfer schedule in GROC format.\nIf t he data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified ti mes are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30 `,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
1344 "type": "string"
1345 },
1346 "updateTime": { 1202 "updateTime": {
1347 "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly", 1203 "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly",
1348 "format": "google-datetime", 1204 "format": "google-datetime",
1349 "type": "string" 1205 "type": "string"
1350 }, 1206 },
1207 "schedule": {
1208 "description": "Data transfer schedule in GROC format.\nIf t he data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified ti mes are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30 `,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
1209 "type": "string"
1210 },
1351 "dataRefreshWindowDays": { 1211 "dataRefreshWindowDays": {
1352 "description": "The number of days to look back to automatic ally refresh the data.\nFor example, if `data_refresh_window_days = 10`, then ev ery day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. S et the value to 0\nto use the default value.", 1212 "description": "The number of days to look back to automatic ally refresh the data.\nFor example, if `data_refresh_window_days = 10`, then ev ery day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. S et the value to 0\nto use the default value.",
1353 "format": "int32", 1213 "format": "int32",
1354 "type": "integer" 1214 "type": "integer"
1355 }, 1215 },
1356 "dataSourceId": { 1216 "dataSourceId": {
1357 "description": "Data source id. Cannot be changed once data transfer is created.", 1217 "description": "Data source id. Cannot be changed once data transfer is created.",
1358 "type": "string" 1218 "type": "string"
1359 }, 1219 },
1360 "status": { 1220 "status": {
(...skipping 11 matching lines...) Expand all
1372 "Status placeholder.", 1232 "Status placeholder.",
1373 "Data transfer is inactive.", 1233 "Data transfer is inactive.",
1374 "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.", 1234 "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
1375 "Data transfer is in progress.", 1235 "Data transfer is in progress.",
1376 "Data transfer completed successsfully.", 1236 "Data transfer completed successsfully.",
1377 "Data transfer failed.", 1237 "Data transfer failed.",
1378 "Data transfer is cancelled." 1238 "Data transfer is cancelled."
1379 ], 1239 ],
1380 "type": "string" 1240 "type": "string"
1381 }, 1241 },
1382 "userId": { 1242 "name": {
1383 "description": "GaiaID of the user on whose behalf transfer is done. Applicable only\nto data sources that do not support service accounts. When set to 0,\nthe data source service account credentials are used.\n@OutputOn ly", 1243 "description": "The resource name of the transfer run.\nTran sfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id} `.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or re quired. The name is ignored when creating a transfer run.",
1384 "format": "int64",
1385 "type": "string" 1244 "type": "string"
1386 }, 1245 },
1387 "destinationDatasetId": { 1246 "destinationDatasetId": {
1388 "description": "The BigQuery target dataset id.", 1247 "description": "The BigQuery target dataset id.",
1389 "type": "string" 1248 "type": "string"
1390 }, 1249 },
1391 "name": { 1250 "userId": {
1392 "description": "The resource name of the transfer run.\nTran sfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id} `.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or re quired. The name is ignored when creating a transfer run.", 1251 "description": "GaiaID of the user on whose behalf transfer is done. Applicable only\nto data sources that do not support service accounts. When set to 0,\nthe data source service account credentials are used.\n@OutputOn ly",
1252 "format": "int64",
1393 "type": "string" 1253 "type": "string"
1394 }, 1254 },
1395 "params": { 1255 "params": {
1396 "additionalProperties": { 1256 "additionalProperties": {
1397 "description": "Properties of the object.", 1257 "description": "Properties of the object.",
1398 "type": "any" 1258 "type": "any"
1399 }, 1259 },
1400 "description": "Data transfer specific parameters.", 1260 "description": "Data transfer specific parameters.",
1401 "type": "object" 1261 "type": "object"
1262 },
1263 "datasetRegion": {
1264 "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
1265 "type": "string"
1402 } 1266 }
1403 }, 1267 },
1404 "type": "object" 1268 "type": "object"
1405 }, 1269 },
1406 "TransferRun": { 1270 "TransferRun": {
1407 "description": "Represents a data transfer run.", 1271 "description": "Represents a data transfer run.",
1408 "id": "TransferRun", 1272 "id": "TransferRun",
1409 "properties": { 1273 "properties": {
1274 "runTime": {
1275 "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
1276 "format": "google-datetime",
1277 "type": "string"
1278 },
1410 "dataSourceId": { 1279 "dataSourceId": {
1411 "description": "Data source id.\n@OutputOnly", 1280 "description": "Data source id.\n@OutputOnly",
1412 "type": "string" 1281 "type": "string"
1413 }, 1282 },
1414 "status": { 1283 "status": {
1415 "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly", 1284 "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly",
1416 "enum": [ 1285 "enum": [
1417 "TRANSFER_STATUS_UNSPECIFIED", 1286 "TRANSFER_STATUS_UNSPECIFIED",
1418 "INACTIVE", 1287 "INACTIVE",
1419 "PENDING", 1288 "PENDING",
1420 "RUNNING", 1289 "RUNNING",
1421 "SUCCEEDED", 1290 "SUCCEEDED",
1422 "FAILED", 1291 "FAILED",
1423 "CANCELLED" 1292 "CANCELLED"
1424 ], 1293 ],
1425 "enumDescriptions": [ 1294 "enumDescriptions": [
1426 "Status placeholder.", 1295 "Status placeholder.",
1427 "Data transfer is inactive.", 1296 "Data transfer is inactive.",
1428 "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.", 1297 "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
1429 "Data transfer is in progress.", 1298 "Data transfer is in progress.",
1430 "Data transfer completed successsfully.", 1299 "Data transfer completed successsfully.",
1431 "Data transfer failed.", 1300 "Data transfer failed.",
1432 "Data transfer is cancelled." 1301 "Data transfer is cancelled."
1433 ], 1302 ],
1434 "type": "string" 1303 "type": "string"
1435 }, 1304 },
1305 "name": {
1306 "description": "The resource name of the transfer run.\nTran sfer run names have the form\n`projects/{project_id}/locations/{location}/transf erConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a trans fer run.",
1307 "type": "string"
1308 },
1436 "userId": { 1309 "userId": {
1437 "description": "The user id for this transfer run.\n@OutputO nly", 1310 "description": "The user id for this transfer run.\n@OutputO nly",
1438 "format": "int64", 1311 "format": "int64",
1439 "type": "string" 1312 "type": "string"
1440 }, 1313 },
1441 "name": {
1442 "description": "The resource name of the transfer run.\nTran sfer run names have the form\n`projects/{project_id}/locations/{location}/transf erConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a trans fer run.",
1443 "type": "string"
1444 },
1445 "destinationDatasetId": { 1314 "destinationDatasetId": {
1446 "description": "The BigQuery target dataset id.", 1315 "description": "The BigQuery target dataset id.",
1447 "type": "string" 1316 "type": "string"
1448 }, 1317 },
1449 "params": { 1318 "params": {
1450 "additionalProperties": { 1319 "additionalProperties": {
1451 "description": "Properties of the object.", 1320 "description": "Properties of the object.",
1452 "type": "any" 1321 "type": "any"
1453 }, 1322 },
1454 "description": "Data transfer specific parameters.", 1323 "description": "Data transfer specific parameters.",
1455 "type": "object" 1324 "type": "object"
1456 }, 1325 },
1457 "endTime": { 1326 "endTime": {
1458 "description": "Time when transfer run ended. Parameter igno red by server for input\nrequests.\n@OutputOnly", 1327 "description": "Time when transfer run ended. Parameter igno red by server for input\nrequests.\n@OutputOnly",
1459 "format": "google-datetime", 1328 "format": "google-datetime",
1460 "type": "string" 1329 "type": "string"
1461 }, 1330 },
1331 "datasetRegion": {
1332 "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
1333 "type": "string"
1334 },
1462 "startTime": { 1335 "startTime": {
1463 "description": "Time when transfer run was started. Paramete r ignored by server for input\nrequests.\n@OutputOnly", 1336 "description": "Time when transfer run was started. Paramete r ignored by server for input\nrequests.\n@OutputOnly",
1464 "format": "google-datetime", 1337 "format": "google-datetime",
1465 "type": "string" 1338 "type": "string"
1466 }, 1339 },
1467 "datasetRegion": {
1468 "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
1469 "type": "string"
1470 },
1471 "scheduleTime": { 1340 "scheduleTime": {
1472 "description": "Minimum time after which a transfer run can be started.", 1341 "description": "Minimum time after which a transfer run can be started.",
1473 "format": "google-datetime", 1342 "format": "google-datetime",
1474 "type": "string" 1343 "type": "string"
1475 }, 1344 },
1476 "schedule": { 1345 "schedule": {
1477 "description": "Describes the schedule of this transfer run if it was created as part of\na regular schedule. For batch transfer runs that a re directly created,\nthis is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matc hes this.\n@OutputOnly", 1346 "description": "Describes the schedule of this transfer run if it was created as part of\na regular schedule. For batch transfer runs that a re directly created,\nthis is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matc hes this.\n@OutputOnly",
1478 "type": "string" 1347 "type": "string"
1479 }, 1348 },
1480 "updateTime": { 1349 "updateTime": {
1481 "description": "Last time the data transfer run status was u pdated.\n@OutputOnly", 1350 "description": "Last time the data transfer run status was u pdated.\n@OutputOnly",
1482 "format": "google-datetime", 1351 "format": "google-datetime",
1483 "type": "string" 1352 "type": "string"
1484 },
1485 "runTime": {
1486 "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
1487 "format": "google-datetime",
1488 "type": "string"
1489 } 1353 }
1490 }, 1354 },
1491 "type": "object" 1355 "type": "object"
1492 }, 1356 },
1493 "CheckValidCredsRequest": { 1357 "CheckValidCredsRequest": {
1494 "description": "A request to determine whether the user has valid cr edentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data sour ce has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the use r id.", 1358 "description": "A request to determine whether the user has valid cr edentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data sour ce has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the use r id.",
1495 "id": "CheckValidCredsRequest", 1359 "id": "CheckValidCredsRequest",
1496 "properties": {}, 1360 "properties": {},
1497 "type": "object" 1361 "type": "object"
1498 }, 1362 },
(...skipping 15 matching lines...) Expand all
1514 "createdRuns": { 1378 "createdRuns": {
1515 "description": "The transfer runs that were created.", 1379 "description": "The transfer runs that were created.",
1516 "items": { 1380 "items": {
1517 "$ref": "TransferRun" 1381 "$ref": "TransferRun"
1518 }, 1382 },
1519 "type": "array" 1383 "type": "array"
1520 } 1384 }
1521 }, 1385 },
1522 "type": "object" 1386 "type": "object"
1523 }, 1387 },
1524 "ListTransferLogsResponse": {
1525 "description": "The returned list transfer run messages.",
1526 "id": "ListTransferLogsResponse",
1527 "properties": {
1528 "nextPageToken": {
1529 "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_to ken`\nto request the next page of list results.\n@OutputOnly",
1530 "type": "string"
1531 },
1532 "transferMessages": {
1533 "description": "The stored pipeline transfer messages.\n@Out putOnly",
1534 "items": {
1535 "$ref": "TransferMessage"
1536 },
1537 "type": "array"
1538 }
1539 },
1540 "type": "object"
1541 },
1542 "TransferMessage": { 1388 "TransferMessage": {
1543 "description": "Represents a user facing message for a particular da ta transfer run.", 1389 "description": "Represents a user facing message for a particular da ta transfer run.",
1544 "id": "TransferMessage", 1390 "id": "TransferMessage",
1545 "properties": { 1391 "properties": {
1546 "messageText": { 1392 "messageText": {
1547 "description": "Message text.", 1393 "description": "Message text.",
1548 "type": "string" 1394 "type": "string"
1549 }, 1395 },
1550 "severity": { 1396 "severity": {
1551 "description": "Message severity.", 1397 "description": "Message severity.",
(...skipping 12 matching lines...) Expand all
1564 "type": "string" 1410 "type": "string"
1565 }, 1411 },
1566 "messageTime": { 1412 "messageTime": {
1567 "description": "Time when message was logged.", 1413 "description": "Time when message was logged.",
1568 "format": "google-datetime", 1414 "format": "google-datetime",
1569 "type": "string" 1415 "type": "string"
1570 } 1416 }
1571 }, 1417 },
1572 "type": "object" 1418 "type": "object"
1573 }, 1419 },
1420 "ListTransferLogsResponse": {
1421 "description": "The returned list transfer run messages.",
1422 "id": "ListTransferLogsResponse",
1423 "properties": {
1424 "nextPageToken": {
1425 "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_to ken`\nto request the next page of list results.\n@OutputOnly",
1426 "type": "string"
1427 },
1428 "transferMessages": {
1429 "description": "The stored pipeline transfer messages.\n@Out putOnly",
1430 "items": {
1431 "$ref": "TransferMessage"
1432 },
1433 "type": "array"
1434 }
1435 },
1436 "type": "object"
1437 },
1574 "ListDataSourcesResponse": { 1438 "ListDataSourcesResponse": {
1575 "description": "Returns list of supported data sources and their met adata.", 1439 "description": "Returns list of supported data sources and their met adata.",
1576 "id": "ListDataSourcesResponse", 1440 "id": "ListDataSourcesResponse",
1577 "properties": { 1441 "properties": {
1578 "nextPageToken": {
1579 "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_toke n`\nto request the next page of list results.\n@OutputOnly",
1580 "type": "string"
1581 },
1582 "dataSources": { 1442 "dataSources": {
1583 "description": "List of supported data sources and their tra nsfer settings.", 1443 "description": "List of supported data sources and their tra nsfer settings.",
1584 "items": { 1444 "items": {
1585 "$ref": "DataSource" 1445 "$ref": "DataSource"
1586 }, 1446 },
1587 "type": "array" 1447 "type": "array"
1448 },
1449 "nextPageToken": {
1450 "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_toke n`\nto request the next page of list results.\n@OutputOnly",
1451 "type": "string"
1588 } 1452 }
1589 }, 1453 },
1590 "type": "object" 1454 "type": "object"
1591 }, 1455 },
1592 "DataSourceParameter": { 1456 "DataSourceParameter": {
1593 "description": "Represents a data source parameter with validation r ules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for renderi ng\nand validation.\nThus, whoever uses this api can decide to generate either g eneric ui,\nor custom data source specific forms.", 1457 "description": "Represents a data source parameter with validation r ules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for renderi ng\nand validation.\nThus, whoever uses this api can decide to generate either g eneric ui,\nor custom data source specific forms.",
1594 "id": "DataSourceParameter", 1458 "id": "DataSourceParameter",
1595 "properties": { 1459 "properties": {
1596 "fields": {
1597 "description": "When parameter is a record, describes child fields.",
1598 "items": {
1599 "$ref": "DataSourceParameter"
1600 },
1601 "type": "array"
1602 },
1603 "maxValue": {
1604 "description": "For integer and double values specifies maxm inum allowed value.",
1605 "format": "double",
1606 "type": "number"
1607 },
1608 "type": {
1609 "description": "Parameter type.",
1610 "enum": [
1611 "TYPE_UNSPECIFIED",
1612 "STRING",
1613 "INTEGER",
1614 "DOUBLE",
1615 "BOOLEAN",
1616 "RECORD",
1617 "PLUS_PAGE"
1618 ],
1619 "enumDescriptions": [
1620 "Type unspecified.",
1621 "String parameter.",
1622 "Integer parameter (64-bits).\nWill be serialized to jso n as string.",
1623 "Double precision floating point parameter.",
1624 "Boolean parameter.",
1625 "Record parameter.",
1626 "Page ID for a Google+ Page."
1627 ],
1628 "type": "string"
1629 },
1630 "recurse": {
1631 "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is R ECORD.",
1632 "type": "boolean"
1633 },
1634 "description": { 1460 "description": {
1635 "description": "Parameter description.", 1461 "description": "Parameter description.",
1636 "type": "string" 1462 "type": "string"
1637 }, 1463 },
1638 "allowedValues": { 1464 "allowedValues": {
1639 "description": "All possible values for the parameter.", 1465 "description": "All possible values for the parameter.",
1640 "items": { 1466 "items": {
1641 "type": "string" 1467 "type": "string"
1642 }, 1468 },
1643 "type": "array" 1469 "type": "array"
(...skipping 20 matching lines...) Expand all
1664 "type": "boolean" 1490 "type": "boolean"
1665 }, 1491 },
1666 "repeated": { 1492 "repeated": {
1667 "description": "Can parameter have multiple values.", 1493 "description": "Can parameter have multiple values.",
1668 "type": "boolean" 1494 "type": "boolean"
1669 }, 1495 },
1670 "displayName": { 1496 "displayName": {
1671 "description": "Parameter display name in the user interface .", 1497 "description": "Parameter display name in the user interface .",
1672 "type": "string" 1498 "type": "string"
1673 }, 1499 },
1500 "immutable": {
1501 "description": "Cannot be changed after initial creation.",
1502 "type": "boolean"
1503 },
1674 "validationDescription": { 1504 "validationDescription": {
1675 "description": "Description of the requirements for this fie ld, in case the user input does\nnot fulfill the regex pattern or min/max values .", 1505 "description": "Description of the requirements for this fie ld, in case the user input does\nnot fulfill the regex pattern or min/max values .",
1676 "type": "string" 1506 "type": "string"
1677 }, 1507 },
1678 "immutable": { 1508 "fields": {
1679 "description": "Cannot be changed after initial creation.", 1509 "description": "When parameter is a record, describes child fields.",
1510 "items": {
1511 "$ref": "DataSourceParameter"
1512 },
1513 "type": "array"
1514 },
1515 "maxValue": {
1516 "description": "For integer and double values specifies maxm inum allowed value.",
1517 "format": "double",
1518 "type": "number"
1519 },
1520 "type": {
1521 "description": "Parameter type.",
1522 "enum": [
1523 "TYPE_UNSPECIFIED",
1524 "STRING",
1525 "INTEGER",
1526 "DOUBLE",
1527 "BOOLEAN",
1528 "RECORD",
1529 "PLUS_PAGE"
1530 ],
1531 "enumDescriptions": [
1532 "Type unspecified.",
1533 "String parameter.",
1534 "Integer parameter (64-bits).\nWill be serialized to jso n as string.",
1535 "Double precision floating point parameter.",
1536 "Boolean parameter.",
1537 "Record parameter.",
1538 "Page ID for a Google+ Page."
1539 ],
1540 "type": "string"
1541 },
1542 "recurse": {
1543 "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is R ECORD.",
1680 "type": "boolean" 1544 "type": "boolean"
1681 } 1545 }
1682 }, 1546 },
1683 "type": "object" 1547 "type": "object"
1684 }, 1548 },
1685 "ListTransferRunsResponse": { 1549 "ListTransferRunsResponse": {
1686 "description": "The returned list of pipelines in the project.", 1550 "description": "The returned list of pipelines in the project.",
1687 "id": "ListTransferRunsResponse", 1551 "id": "ListTransferRunsResponse",
1688 "properties": { 1552 "properties": {
1689 "nextPageToken": {
1690 "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_tok en`\nto request the next page of list results.\n@OutputOnly",
1691 "type": "string"
1692 },
1693 "transferRuns": { 1553 "transferRuns": {
1694 "description": "The stored pipeline transfer runs.\n@OutputO nly", 1554 "description": "The stored pipeline transfer runs.\n@OutputO nly",
1695 "items": { 1555 "items": {
1696 "$ref": "TransferRun" 1556 "$ref": "TransferRun"
1697 }, 1557 },
1698 "type": "array" 1558 "type": "array"
1559 },
1560 "nextPageToken": {
1561 "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_tok en`\nto request the next page of list results.\n@OutputOnly",
1562 "type": "string"
1699 } 1563 }
1700 }, 1564 },
1701 "type": "object" 1565 "type": "object"
1702 }, 1566 },
1703 "IsEnabledRequest": { 1567 "IsEnabledRequest": {
1704 "description": "A request to determine whether data transfer is enab led for the project.", 1568 "description": "A request to determine whether data transfer is enab led for the project.",
1705 "id": "IsEnabledRequest", 1569 "id": "IsEnabledRequest",
1706 "properties": {}, 1570 "properties": {},
1707 "type": "object" 1571 "type": "object"
1708 }, 1572 },
1573 "SetEnabledRequest": {
1574 "description": "A request to set whether data transfer is enabled or disabled for a project.",
1575 "id": "SetEnabledRequest",
1576 "properties": {
1577 "enabled": {
1578 "description": "Whether data transfer should be enabled or d isabled for the project.",
1579 "type": "boolean"
1580 }
1581 },
1582 "type": "object"
1583 },
1709 "ListTransferConfigsResponse": { 1584 "ListTransferConfigsResponse": {
1710 "description": "The returned list of pipelines in the project.", 1585 "description": "The returned list of pipelines in the project.",
1711 "id": "ListTransferConfigsResponse", 1586 "id": "ListTransferConfigsResponse",
1712 "properties": { 1587 "properties": {
1713 "transferConfigs": { 1588 "transferConfigs": {
1714 "description": "The stored pipeline transfer configurations. \n@OutputOnly", 1589 "description": "The stored pipeline transfer configurations. \n@OutputOnly",
1715 "items": { 1590 "items": {
1716 "$ref": "TransferConfig" 1591 "$ref": "TransferConfig"
1717 }, 1592 },
1718 "type": "array" 1593 "type": "array"
1719 }, 1594 },
1720 "nextPageToken": { 1595 "nextPageToken": {
1721 "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_ token`\nto request the next page of list results.\n@OutputOnly", 1596 "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_ token`\nto request the next page of list results.\n@OutputOnly",
1722 "type": "string" 1597 "type": "string"
1723 } 1598 }
1724 }, 1599 },
1725 "type": "object" 1600 "type": "object"
1726 }, 1601 },
1727 "SetEnabledRequest": {
1728 "description": "A request to set whether data transfer is enabled or disabled for a project.",
1729 "id": "SetEnabledRequest",
1730 "properties": {
1731 "enabled": {
1732 "description": "Whether data transfer should be enabled or d isabled for the project.",
1733 "type": "boolean"
1734 }
1735 },
1736 "type": "object"
1737 },
1738 "IsEnabledResponse": { 1602 "IsEnabledResponse": {
1739 "description": "A response to indicate whether data transfer is enab led for the project.", 1603 "description": "A response to indicate whether data transfer is enab led for the project.",
1740 "id": "IsEnabledResponse", 1604 "id": "IsEnabledResponse",
1741 "properties": { 1605 "properties": {
1742 "enabled": { 1606 "enabled": {
1743 "description": "Indicates whether the project is enabled.", 1607 "description": "Indicates whether the project is enabled.",
1744 "type": "boolean" 1608 "type": "boolean"
1745 } 1609 }
1746 }, 1610 },
1747 "type": "object" 1611 "type": "object"
1612 },
1613 "DataSource": {
1614 "description": "Represents data source metadata. Metadata is suffici ent to\nrender UI and request proper OAuth tokens.",
1615 "id": "DataSource",
1616 "properties": {
1617 "helpUrl": {
1618 "description": "Url for the help document for this data sour ce.",
1619 "type": "string"
1620 },
1621 "defaultSchedule": {
1622 "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of j an,jun 13:15`, and\n`first sunday of quarter 00:00`.",
1623 "type": "string"
1624 },
1625 "statusUpdateDeadlineSeconds": {
1626 "description": "The number of seconds to wait for a status u pdate from the data source\nbefore BigQuery marks the transfer as failed.",
1627 "format": "int32",
1628 "type": "integer"
1629 },
1630 "supportsMultipleTransfers": {
1631 "description": "Indicates whether the data source supports m ultiple transfers\nto different BigQuery targets.",
1632 "type": "boolean"
1633 },
1634 "defaultDataRefreshWindowDays": {
1635 "description": "Default data refresh window on days.\nOnly m eaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
1636 "format": "int32",
1637 "type": "integer"
1638 },
1639 "manualRunsDisabled": {
1640 "description": "Disables backfilling and manual run scheduli ng\nfor the data source.",
1641 "type": "boolean"
1642 },
1643 "transferType": {
1644 "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquer y) to ingest the data.",
1645 "enum": [
1646 "TRANSFER_TYPE_UNSPECIFIED",
1647 "BATCH",
1648 "STREAMING"
1649 ],
1650 "enumDescriptions": [
1651 "Invalid or Unknown transfer type placeholder.",
1652 "Batch data transfer.",
1653 "Streaming data transfer. Streaming data source currentl y doesn't\nsupport multiple transfer configs per project."
1654 ],
1655 "type": "string"
1656 },
1657 "description": {
1658 "description": "User friendly data source description string .",
1659 "type": "string"
1660 },
1661 "dataSourceId": {
1662 "description": "Data source id.",
1663 "type": "string"
1664 },
1665 "scopes": {
1666 "description": "Api auth scopes for which refresh token need s to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into B igQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
1667 "items": {
1668 "type": "string"
1669 },
1670 "type": "array"
1671 },
1672 "name": {
1673 "description": "Data source resource name.",
1674 "type": "string"
1675 },
1676 "clientId": {
1677 "description": "Data source client id which should be used t o receive refresh token.\nWhen not supplied, no offline credentials are populate d for data transfer.",
1678 "type": "string"
1679 },
1680 "authorizationType": {
1681 "description": "Indicates the type of authorization.",
1682 "enum": [
1683 "AUTHORIZATION_TYPE_UNSPECIFIED",
1684 "AUTHORIZATION_CODE",
1685 "GOOGLE_PLUS_AUTHORIZATION_CODE"
1686 ],
1687 "enumDescriptions": [
1688 "Type unspecified.",
1689 "Use OAuth 2 authorization codes that can be exchanged\n for a refresh token on the backend.",
1690 "Return an authorization code for a given Google+ page t hat can then be\nexchanged for a refresh token on the backend."
1691 ],
1692 "type": "string"
1693 },
1694 "supportsCustomSchedule": {
1695 "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true `, user can override default schedule.",
1696 "type": "boolean"
1697 },
1698 "displayName": {
1699 "description": "User friendly data source name.",
1700 "type": "string"
1701 },
1702 "dataRefreshType": {
1703 "description": "Specifies whether the data source supports a utomatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
1704 "enum": [
1705 "NONE",
1706 "SLIDING_WINDOW",
1707 "CUSTOM_SLIDING_WINDOW"
1708 ],
1709 "enumDescriptions": [
1710 "The data source won't support data auto refresh, which is default value.",
1711 "The data source supports data auto refresh, and runs wi ll be scheduled\nfor the past few days. Does not allow custom values to be set f or each\ntransfer config.",
1712 "The data source supports data auto refresh, and runs wi ll be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
1713 ],
1714 "type": "string"
1715 },
1716 "parameters": {
1717 "description": "Data source parameters.",
1718 "items": {
1719 "$ref": "DataSourceParameter"
1720 },
1721 "type": "array"
1722 }
1723 },
1724 "type": "object"
1725 },
1726 "ScheduleTransferRunsRequest": {
1727 "description": "A request to schedule transfer runs for a time range .",
1728 "id": "ScheduleTransferRunsRequest",
1729 "properties": {
1730 "rangeEndTime": {
1731 "description": "End time of the range of transfer runs.",
1732 "format": "google-datetime",
1733 "type": "string"
1734 },
1735 "rangeStartTime": {
1736 "description": "Start time of the range of transfer runs.",
1737 "format": "google-datetime",
1738 "type": "string"
1739 }
1740 },
1741 "type": "object"
1742 },
1743 "Empty": {
1744 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
1745 "id": "Empty",
1746 "properties": {},
1747 "type": "object"
1748 } 1748 }
1749 }, 1749 },
1750 "servicePath": "", 1750 "servicePath": "",
1751 "title": "BigQuery Data Transfer Service API", 1751 "title": "BigQuery Data Transfer Service API",
1752 "version": "v1" 1752 "version": "v1"
1753 } 1753 }
OLDNEW
« no previous file with comments | « discovery/googleapis/bigquery__v2.json ('k') | discovery/googleapis/calendar__v3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698