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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 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/blogger__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": { 5 "https://www.googleapis.com/auth/bigquery": {
6 "description": "View and manage your data in Google BigQuery " 6 "description": "View and manage your data in Google BigQuery "
7 }, 7 },
8 "https://www.googleapis.com/auth/cloud-platform.read-only": { 8 "https://www.googleapis.com/auth/cloud-platform.read-only": {
9 "description": "View your data across Google Cloud Platform services" 9 "description": "View your data across Google Cloud Platform services"
10 }, 10 },
(...skipping 13 matching lines...) Expand all
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 "oauth_token": {
35 "description": "OAuth 2.0 token for the current user.",
36 "location": "query",
37 "type": "string"
38 },
39 "bearer_token": {
40 "description": "OAuth bearer token.",
41 "location": "query",
42 "type": "string"
43 },
44 "upload_protocol": { 34 "upload_protocol": {
45 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 35 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
46 "location": "query", 36 "location": "query",
47 "type": "string" 37 "type": "string"
48 }, 38 },
49 "prettyPrint": { 39 "prettyPrint": {
50 "default": "true", 40 "default": "true",
51 "description": "Returns response with indentations and line breaks." , 41 "description": "Returns response with indentations and line breaks." ,
52 "location": "query", 42 "location": "query",
53 "type": "boolean" 43 "type": "boolean"
54 }, 44 },
55 "uploadType": { 45 "uploadType": {
56 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 46 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
57 "location": "query", 47 "location": "query",
58 "type": "string" 48 "type": "string"
59 }, 49 },
60 "fields": { 50 "fields": {
61 "description": "Selector specifying which fields to include in a par tial response.", 51 "description": "Selector specifying which fields to include in a par tial response.",
62 "location": "query", 52 "location": "query",
63 "type": "string" 53 "type": "string"
64 }, 54 },
65 "callback": {
66 "description": "JSONP",
67 "location": "query",
68 "type": "string"
69 },
70 "$.xgafv": { 55 "$.xgafv": {
71 "description": "V1 error format.", 56 "description": "V1 error format.",
72 "enum": [ 57 "enum": [
73 "1", 58 "1",
74 "2" 59 "2"
75 ], 60 ],
76 "enumDescriptions": [ 61 "enumDescriptions": [
77 "v1 error format", 62 "v1 error format",
78 "v2 error format" 63 "v2 error format"
79 ], 64 ],
80 "location": "query", 65 "location": "query",
81 "type": "string" 66 "type": "string"
82 }, 67 },
68 "callback": {
69 "description": "JSONP",
70 "location": "query",
71 "type": "string"
72 },
83 "alt": { 73 "alt": {
84 "default": "json", 74 "default": "json",
85 "description": "Data format for response.", 75 "description": "Data format for response.",
86 "enum": [ 76 "enum": [
87 "json", 77 "json",
88 "media", 78 "media",
89 "proto" 79 "proto"
90 ], 80 ],
91 "enumDescriptions": [ 81 "enumDescriptions": [
92 "Responses with Content-Type of application/json", 82 "Responses with Content-Type of application/json",
(...skipping 16 matching lines...) Expand all
109 "quotaUser": { 99 "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.", 100 "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", 101 "location": "query",
112 "type": "string" 102 "type": "string"
113 }, 103 },
114 "pp": { 104 "pp": {
115 "default": "true", 105 "default": "true",
116 "description": "Pretty-print response.", 106 "description": "Pretty-print response.",
117 "location": "query", 107 "location": "query",
118 "type": "boolean" 108 "type": "boolean"
109 },
110 "bearer_token": {
111 "description": "OAuth bearer token.",
112 "location": "query",
113 "type": "string"
114 },
115 "oauth_token": {
116 "description": "OAuth 2.0 token for the current user.",
117 "location": "query",
118 "type": "string"
119 } 119 }
120 }, 120 },
121 "protocol": "rest", 121 "protocol": "rest",
122 "resources": { 122 "resources": {
123 "projects": { 123 "projects": {
124 "methods": { 124 "methods": {
125 "isEnabled": { 125 "setEnabled": {
126 "description": "Returns true if data transfer is enabled for a project.", 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.",
127 "httpMethod": "POST", 127 "httpMethod": "POST",
128 "id": "bigquerydatatransfer.projects.isEnabled", 128 "id": "bigquerydatatransfer.projects.setEnabled",
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}:isEnabled", 141 "path": "v1/{+name}:setEnabled",
142 "request": { 142 "request": {
143 "$ref": "IsEnabledRequest" 143 "$ref": "SetEnabledRequest"
144 }, 144 },
145 "response": { 145 "response": {
146 "$ref": "IsEnabledResponse" 146 "$ref": "Empty"
147 }, 147 },
148 "scopes": [ 148 "scopes": [
149 "https://www.googleapis.com/auth/bigquery", 149 "https://www.googleapis.com/auth/cloud-platform"
150 "https://www.googleapis.com/auth/cloud-platform",
151 "https://www.googleapis.com/auth/cloud-platform.read-onl y"
152 ] 150 ]
153 }, 151 },
154 "setEnabled": { 152 "isEnabled": {
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.", 153 "description": "Returns true if data transfer is enabled for a project.",
156 "httpMethod": "POST", 154 "httpMethod": "POST",
157 "id": "bigquerydatatransfer.projects.setEnabled", 155 "id": "bigquerydatatransfer.projects.isEnabled",
158 "parameterOrder": [ 156 "parameterOrder": [
159 "name" 157 "name"
160 ], 158 ],
161 "parameters": { 159 "parameters": {
162 "name": { 160 "name": {
163 "description": "The name of the project resource in the form:\n`projects/{project_id}`", 161 "description": "The name of the project resource in the form:\n`projects/{project_id}`",
164 "location": "path", 162 "location": "path",
165 "pattern": "^projects/[^/]+$", 163 "pattern": "^projects/[^/]+$",
166 "required": true, 164 "required": true,
167 "type": "string" 165 "type": "string"
168 } 166 }
169 }, 167 },
170 "path": "v1/{+name}:setEnabled", 168 "path": "v1/{+name}:isEnabled",
171 "request": { 169 "request": {
172 "$ref": "SetEnabledRequest" 170 "$ref": "IsEnabledRequest"
173 }, 171 },
174 "response": { 172 "response": {
175 "$ref": "Empty" 173 "$ref": "IsEnabledResponse"
176 }, 174 },
177 "scopes": [ 175 "scopes": [
178 "https://www.googleapis.com/auth/cloud-platform" 176 "https://www.googleapis.com/auth/bigquery",
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 "transferConfigs": {
184 "methods": { 184 "methods": {
185 "isEnabled": { 185 "patch": {
186 "description": "Returns true if data transfer is ena bled for a project.", 186 "description": "Updates a data transfer configuratio n.\nAll fields must be set, even if they are not updated.",
187 "httpMethod": "POST", 187 "httpMethod": "PATCH",
188 "id": "bigquerydatatransfer.projects.locations.isEna bled", 188 "id": "bigquerydatatransfer.projects.transferConfigs .patch",
189 "parameterOrder": [ 189 "parameterOrder": [
190 "name" 190 "name"
191 ], 191 ],
192 "parameters": { 192 "parameters": {
193 "authorizationCode": {
194 "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.",
195 "location": "query",
196 "type": "string"
197 },
198 "updateMask": {
199 "description": "Required list of fields to b e updated in this request.",
200 "format": "google-fieldmask",
201 "location": "query",
202 "type": "string"
203 },
193 "name": { 204 "name": {
194 "description": "The name of the project reso urce in the form:\n`projects/{project_id}`", 205 "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.",
195 "location": "path", 206 "location": "path",
196 "pattern": "^projects/[^/]+/locations/[^/]+$ ", 207 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
197 "required": true, 208 "required": true,
198 "type": "string" 209 "type": "string"
199 } 210 }
200 }, 211 },
201 "path": "v1/{+name}:isEnabled", 212 "path": "v1/{+name}",
202 "request": { 213 "request": {
203 "$ref": "IsEnabledRequest" 214 "$ref": "TransferConfig"
204 }, 215 },
205 "response": { 216 "response": {
206 "$ref": "IsEnabledResponse" 217 "$ref": "TransferConfig"
218 },
219 "scopes": [
220 "https://www.googleapis.com/auth/bigquery",
221 "https://www.googleapis.com/auth/cloud-platform"
222 ]
223 },
224 "get": {
225 "description": "Returns information about a data tra nsfer config.",
226 "httpMethod": "GET",
227 "id": "bigquerydatatransfer.projects.transferConfigs .get",
228 "parameterOrder": [
229 "name"
230 ],
231 "parameters": {
232 "name": {
233 "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/ {config_id}`",
234 "location": "path",
235 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
236 "required": true,
237 "type": "string"
238 }
239 },
240 "path": "v1/{+name}",
241 "response": {
242 "$ref": "TransferConfig"
207 }, 243 },
208 "scopes": [ 244 "scopes": [
209 "https://www.googleapis.com/auth/bigquery", 245 "https://www.googleapis.com/auth/bigquery",
210 "https://www.googleapis.com/auth/cloud-platform" , 246 "https://www.googleapis.com/auth/cloud-platform" ,
211 "https://www.googleapis.com/auth/cloud-platform. read-only" 247 "https://www.googleapis.com/auth/cloud-platform. read-only"
212 ] 248 ]
213 }, 249 },
214 "setEnabled": { 250 "delete": {
215 "description": "Enables or disables data transfer fo r a project. This\nmethod requires the additional scope of\n'https://www.googlea pis.com/auth/cloudplatformprojects'\nto manage the cloud project permissions.", 251 "description": "Deletes a data transfer configuratio n,\nincluding any associated transfer runs and logs.",
216 "httpMethod": "POST", 252 "httpMethod": "DELETE",
217 "id": "bigquerydatatransfer.projects.locations.setEn abled", 253 "id": "bigquerydatatransfer.projects.transferConfigs .delete",
218 "parameterOrder": [ 254 "parameterOrder": [
219 "name" 255 "name"
220 ], 256 ],
221 "parameters": { 257 "parameters": {
222 "name": { 258 "name": {
223 "description": "The name of the project reso urce in the form:\n`projects/{project_id}`", 259 "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/ {config_id}`",
224 "location": "path", 260 "location": "path",
225 "pattern": "^projects/[^/]+/locations/[^/]+$ ", 261 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
226 "required": true, 262 "required": true,
227 "type": "string" 263 "type": "string"
228 } 264 }
229 }, 265 },
230 "path": "v1/{+name}:setEnabled", 266 "path": "v1/{+name}",
231 "request": {
232 "$ref": "SetEnabledRequest"
233 },
234 "response": { 267 "response": {
235 "$ref": "Empty" 268 "$ref": "Empty"
236 }, 269 },
237 "scopes": [ 270 "scopes": [
238 "https://www.googleapis.com/auth/cloud-platform" 271 "https://www.googleapis.com/auth/bigquery",
239 ] 272 "https://www.googleapis.com/auth/cloud-platform"
240 }, 273 ]
241 "get": { 274 },
242 "description": "Get information about a location.", 275 "list": {
276 "description": "Returns information about all data t ransfers in the project.",
243 "httpMethod": "GET", 277 "httpMethod": "GET",
244 "id": "bigquerydatatransfer.projects.locations.get", 278 "id": "bigquerydatatransfer.projects.transferConfigs .list",
245 "parameterOrder": [ 279 "parameterOrder": [
246 "name" 280 "parent"
247 ], 281 ],
248 "parameters": { 282 "parameters": {
249 "name": { 283 "dataSourceIds": {
250 "description": "Resource name for the locati on.", 284 "description": "When specified, only configu rations of requested data sources are returned.",
251 "location": "path", 285 "location": "query",
252 "pattern": "^projects/[^/]+/locations/[^/]+$ ", 286 "repeated": true,
253 "required": true, 287 "type": "string"
254 "type": "string" 288 },
255 } 289 "parent": {
256 }, 290 "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
257 "path": "v1/{+name}", 291 "location": "path",
258 "response": { 292 "pattern": "^projects/[^/]+$",
259 "$ref": "Location" 293 "required": true,
294 "type": "string"
295 },
296 "pageToken": {
297 "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.",
298 "location": "query",
299 "type": "string"
300 },
301 "pageSize": {
302 "description": "Page size. The default page size is the maximum value of 1000 results.",
303 "format": "int32",
304 "location": "query",
305 "type": "integer"
306 }
307 },
308 "path": "v1/{+parent}/transferConfigs",
309 "response": {
310 "$ref": "ListTransferConfigsResponse"
260 }, 311 },
261 "scopes": [ 312 "scopes": [
262 "https://www.googleapis.com/auth/bigquery", 313 "https://www.googleapis.com/auth/bigquery",
263 "https://www.googleapis.com/auth/cloud-platform" , 314 "https://www.googleapis.com/auth/cloud-platform" ,
264 "https://www.googleapis.com/auth/cloud-platform. read-only" 315 "https://www.googleapis.com/auth/cloud-platform. read-only"
265 ] 316 ]
266 }, 317 },
267 "list": { 318 "create": {
268 "description": "Lists information about the supporte d locations for this service.", 319 "description": "Creates a new data transfer configur ation.",
269 "httpMethod": "GET", 320 "httpMethod": "POST",
270 "id": "bigquerydatatransfer.projects.locations.list" , 321 "id": "bigquerydatatransfer.projects.transferConfigs .create",
271 "parameterOrder": [ 322 "parameterOrder": [
272 "name" 323 "parent"
273 ], 324 ],
274 "parameters": { 325 "parameters": {
275 "filter": { 326 "parent": {
276 "description": "The standard list filter.", 327 "description": "The BigQuery project id wher e the transfer configuration should be created.\nMust be in the format /projects /{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nI n case when '-' is specified as location_id, location is infered from\nthe desti nation dataset region.",
277 "location": "query",
278 "type": "string"
279 },
280 "pageToken": {
281 "description": "The standard list page token .",
282 "location": "query",
283 "type": "string"
284 },
285 "name": {
286 "description": "The resource that owns the l ocations collection, if applicable.",
287 "location": "path", 328 "location": "path",
288 "pattern": "^projects/[^/]+$", 329 "pattern": "^projects/[^/]+$",
289 "required": true, 330 "required": true,
290 "type": "string" 331 "type": "string"
291 }, 332 },
292 "pageSize": { 333 "authorizationCode": {
293 "description": "The standard list page size. ", 334 "description": "Optional OAuth2 authorizatio n code to use with this transfer configuration.\nThis is required if new credent ials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authori zation_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatran sfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>& redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* dat a_source_scopes are the scopes returned by ListDataSources method.\n* redirect_u ri is an optional parameter. If not specified, then\n authorization code is pos ted 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 aut horization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application .",
294 "format": "int32", 335 "location": "query",
295 "location": "query", 336 "type": "string"
296 "type": "integer" 337 }
297 } 338 },
298 }, 339 "path": "v1/{+parent}/transferConfigs",
299 "path": "v1/{+name}/locations", 340 "request": {
300 "response": { 341 "$ref": "TransferConfig"
301 "$ref": "ListLocationsResponse" 342 },
302 }, 343 "response": {
303 "scopes": [ 344 "$ref": "TransferConfig"
304 "https://www.googleapis.com/auth/bigquery", 345 },
305 "https://www.googleapis.com/auth/cloud-platform" , 346 "scopes": [
306 "https://www.googleapis.com/auth/cloud-platform. read-only" 347 "https://www.googleapis.com/auth/bigquery",
348 "https://www.googleapis.com/auth/cloud-platform"
349 ]
350 },
351 "scheduleRuns": {
352 "description": "Creates transfer runs for a time ran ge [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote tha t runs are created per UTC time in the time range.",
353 "httpMethod": "POST",
354 "id": "bigquerydatatransfer.projects.transferConfigs .scheduleRuns",
355 "parameterOrder": [
356 "parent"
357 ],
358 "parameters": {
359 "parent": {
360 "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
361 "location": "path",
362 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
363 "required": true,
364 "type": "string"
365 }
366 },
367 "path": "v1/{+parent}:scheduleRuns",
368 "request": {
369 "$ref": "ScheduleTransferRunsRequest"
370 },
371 "response": {
372 "$ref": "ScheduleTransferRunsResponse"
373 },
374 "scopes": [
375 "https://www.googleapis.com/auth/bigquery",
376 "https://www.googleapis.com/auth/cloud-platform"
307 ] 377 ]
308 } 378 }
309 }, 379 },
310 "resources": { 380 "resources": {
311 "transferConfigs": { 381 "runs": {
312 "methods": { 382 "methods": {
313 "scheduleRuns": { 383 "delete": {
314 "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever gran ularity the data source supports - in the\nrange, one transfer run is created.\n Note that runs are created per UTC time in the time range.", 384 "description": "Deletes the specified transf er run.",
315 "httpMethod": "POST", 385 "httpMethod": "DELETE",
316 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.scheduleRuns", 386 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.delete",
317 "parameterOrder": [
318 "parent"
319 ],
320 "parameters": {
321 "parent": {
322 "description": "Transfer configurati on name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
323 "location": "path",
324 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
325 "required": true,
326 "type": "string"
327 }
328 },
329 "path": "v1/{+parent}:scheduleRuns",
330 "request": {
331 "$ref": "ScheduleTransferRunsRequest"
332 },
333 "response": {
334 "$ref": "ScheduleTransferRunsResponse"
335 },
336 "scopes": [
337 "https://www.googleapis.com/auth/bigquer y",
338 "https://www.googleapis.com/auth/cloud-p latform"
339 ]
340 },
341 "patch": {
342 "description": "Updates a data transfer conf iguration.\nAll fields must be set, even if they are not updated.",
343 "httpMethod": "PATCH",
344 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.patch",
345 "parameterOrder": [
346 "name"
347 ],
348 "parameters": {
349 "authorizationCode": {
350 "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.",
351 "location": "query",
352 "type": "string"
353 },
354 "updateMask": {
355 "description": "Required list of fie lds to be updated in this request.",
356 "format": "google-fieldmask",
357 "location": "query",
358 "type": "string"
359 },
360 "name": {
361 "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 .",
362 "location": "path",
363 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
364 "required": true,
365 "type": "string"
366 }
367 },
368 "path": "v1/{+name}",
369 "request": {
370 "$ref": "TransferConfig"
371 },
372 "response": {
373 "$ref": "TransferConfig"
374 },
375 "scopes": [
376 "https://www.googleapis.com/auth/bigquer y",
377 "https://www.googleapis.com/auth/cloud-p latform"
378 ]
379 },
380 "get": {
381 "description": "Returns information about a data transfer config.",
382 "httpMethod": "GET",
383 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.get",
384 "parameterOrder": [ 387 "parameterOrder": [
385 "name" 388 "name"
386 ], 389 ],
387 "parameters": { 390 "parameters": {
388 "name": { 391 "name": {
389 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}`", 392 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}/runs/{run_id}`",
390 "location": "path", 393 "location": "path",
391 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$", 394 "pattern": "^projects/[^/]+/transfer Configs/[^/]+/runs/[^/]+$",
392 "required": true,
393 "type": "string"
394 }
395 },
396 "path": "v1/{+name}",
397 "response": {
398 "$ref": "TransferConfig"
399 },
400 "scopes": [
401 "https://www.googleapis.com/auth/bigquer y",
402 "https://www.googleapis.com/auth/cloud-p latform",
403 "https://www.googleapis.com/auth/cloud-p latform.read-only"
404 ]
405 },
406 "delete": {
407 "description": "Deletes a data transfer conf iguration,\nincluding any associated transfer runs and logs.",
408 "httpMethod": "DELETE",
409 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.delete",
410 "parameterOrder": [
411 "name"
412 ],
413 "parameters": {
414 "name": {
415 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}`",
416 "location": "path",
417 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
418 "required": true, 395 "required": true,
419 "type": "string" 396 "type": "string"
420 } 397 }
421 }, 398 },
422 "path": "v1/{+name}", 399 "path": "v1/{+name}",
423 "response": { 400 "response": {
424 "$ref": "Empty" 401 "$ref": "Empty"
425 }, 402 },
426 "scopes": [ 403 "scopes": [
427 "https://www.googleapis.com/auth/bigquer y", 404 "https://www.googleapis.com/auth/bigquer y",
428 "https://www.googleapis.com/auth/cloud-p latform" 405 "https://www.googleapis.com/auth/cloud-p latform"
429 ] 406 ]
430 }, 407 },
431 "list": { 408 "list": {
432 "description": "Returns information about al l data transfers in the project.", 409 "description": "Returns information about ru nning and completed jobs.",
433 "httpMethod": "GET", 410 "httpMethod": "GET",
434 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.list", 411 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.list",
435 "parameterOrder": [ 412 "parameterOrder": [
436 "parent" 413 "parent"
437 ], 414 ],
438 "parameters": { 415 "parameters": {
439 "pageToken": {
440 "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.",
441 "location": "query",
442 "type": "string"
443 },
444 "pageSize": { 416 "pageSize": {
445 "description": "Page size. The defau lt page size is the maximum value of 1000 results.", 417 "description": "Page size. The defau lt page size is the maximum value of 1000 results.",
446 "format": "int32", 418 "format": "int32",
447 "location": "query", 419 "location": "query",
448 "type": "integer" 420 "type": "integer"
449 }, 421 },
450 "dataSourceIds": { 422 "states": {
451 "description": "When specified, only configurations of requested data sources are returned.", 423 "description": "When specified, only transfer runs with requested states are returned.",
424 "enum": [
425 "TRANSFER_STATE_UNSPECIFIED",
426 "INACTIVE",
427 "PENDING",
428 "RUNNING",
429 "SUCCEEDED",
430 "FAILED",
431 "CANCELLED"
432 ],
452 "location": "query", 433 "location": "query",
453 "repeated": true, 434 "repeated": true,
454 "type": "string" 435 "type": "string"
455 }, 436 },
437 "runAttempt": {
438 "description": "Indicates how run at tempts are to be pulled.",
439 "enum": [
440 "RUN_ATTEMPT_UNSPECIFIED",
441 "LATEST"
442 ],
443 "location": "query",
444 "type": "string"
445 },
456 "parent": { 446 "parent": {
457 "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.", 447 "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}` .",
458 "location": "path", 448 "location": "path",
459 "pattern": "^projects/[^/]+/location s/[^/]+$", 449 "pattern": "^projects/[^/]+/transfer Configs/[^/]+$",
460 "required": true, 450 "required": true,
461 "type": "string" 451 "type": "string"
452 },
453 "pageToken": {
454 "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.",
455 "location": "query",
456 "type": "string"
462 } 457 }
463 }, 458 },
464 "path": "v1/{+parent}/transferConfigs", 459 "path": "v1/{+parent}/runs",
465 "response": { 460 "response": {
466 "$ref": "ListTransferConfigsResponse" 461 "$ref": "ListTransferRunsResponse"
467 }, 462 },
468 "scopes": [ 463 "scopes": [
469 "https://www.googleapis.com/auth/bigquer y", 464 "https://www.googleapis.com/auth/bigquer y",
470 "https://www.googleapis.com/auth/cloud-p latform", 465 "https://www.googleapis.com/auth/cloud-p latform",
471 "https://www.googleapis.com/auth/cloud-p latform.read-only" 466 "https://www.googleapis.com/auth/cloud-p latform.read-only"
472 ] 467 ]
473 }, 468 },
474 "create": { 469 "get": {
475 "description": "Creates a new data transfer configuration.", 470 "description": "Returns information about th e particular transfer run.",
476 "httpMethod": "POST", 471 "httpMethod": "GET",
477 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.create", 472 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.get",
478 "parameterOrder": [ 473 "parameterOrder": [
479 "parent" 474 "name"
480 ], 475 ],
481 "parameters": { 476 "parameters": {
482 "authorizationCode": { 477 "name": {
483 "description": "Optional OAuth2 auth orization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquery datatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_ scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method .\n* data_source_scopes are the scopes returned by ListDataSources method.\n* re direct_uri is an optional parameter. If not specified, then\n authorization cod e 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 title bar of the browser, w ith the page text prompting\n the user to copy the code and paste it in the app lication.", 478 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}/runs/{run_id}`",
484 "location": "query",
485 "type": "string"
486 },
487 "parent": {
488 "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format / projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locati ons/-\nIn case when '-' is specified as location_id, location is infered from\nt he destination dataset region.",
489 "location": "path", 479 "location": "path",
490 "pattern": "^projects/[^/]+/location s/[^/]+$", 480 "pattern": "^projects/[^/]+/transfer Configs/[^/]+/runs/[^/]+$",
491 "required": true, 481 "required": true,
492 "type": "string" 482 "type": "string"
493 } 483 }
494 }, 484 },
495 "path": "v1/{+parent}/transferConfigs", 485 "path": "v1/{+name}",
496 "request": {
497 "$ref": "TransferConfig"
498 },
499 "response": { 486 "response": {
500 "$ref": "TransferConfig" 487 "$ref": "TransferRun"
501 }, 488 },
502 "scopes": [ 489 "scopes": [
503 "https://www.googleapis.com/auth/bigquer y", 490 "https://www.googleapis.com/auth/bigquer y",
504 "https://www.googleapis.com/auth/cloud-p latform" 491 "https://www.googleapis.com/auth/cloud-p latform",
492 "https://www.googleapis.com/auth/cloud-p latform.read-only"
505 ] 493 ]
506 } 494 }
507 }, 495 },
508 "resources": { 496 "resources": {
509 "runs": { 497 "transferLogs": {
510 "methods": { 498 "methods": {
511 "delete": {
512 "description": "Deletes the specifie d transfer run.",
513 "httpMethod": "DELETE",
514 "id": "bigquerydatatransfer.projects .locations.transferConfigs.runs.delete",
515 "parameterOrder": [
516 "name"
517 ],
518 "parameters": {
519 "name": {
520 "description": "The field wi ll contain name of the resource requested, for example:\n`projects/{project_id}/ transferConfigs/{config_id}/runs/{run_id}`",
521 "location": "path",
522 "pattern": "^projects/[^/]+/ locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
523 "required": true,
524 "type": "string"
525 }
526 },
527 "path": "v1/{+name}",
528 "response": {
529 "$ref": "Empty"
530 },
531 "scopes": [
532 "https://www.googleapis.com/auth /bigquery",
533 "https://www.googleapis.com/auth /cloud-platform"
534 ]
535 },
536 "list": { 499 "list": {
537 "description": "Returns information about running and completed jobs.", 500 "description": "Returns user facing log messages for the data transfer run.",
538 "httpMethod": "GET", 501 "httpMethod": "GET",
539 "id": "bigquerydatatransfer.projects .locations.transferConfigs.runs.list", 502 "id": "bigquerydatatransfer.projects .transferConfigs.runs.transferLogs.list",
540 "parameterOrder": [ 503 "parameterOrder": [
541 "parent" 504 "parent"
542 ], 505 ],
543 "parameters": { 506 "parameters": {
544 "pageToken": { 507 "pageToken": {
545 "description": "Pagination t oken, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", 508 "description": "Pagination t oken, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
546 "location": "query", 509 "location": "query",
547 "type": "string" 510 "type": "string"
548 }, 511 },
549 "pageSize": { 512 "pageSize": {
550 "description": "Page size. T he default page size is the maximum value of 1000 results.", 513 "description": "Page size. T he default page size is the maximum value of 1000 results.",
551 "format": "int32", 514 "format": "int32",
552 "location": "query", 515 "location": "query",
553 "type": "integer" 516 "type": "integer"
554 }, 517 },
555 "statuses": { 518 "messageTypes": {
556 "description": "When specifi ed, only transfer runs with requested statuses are returned.", 519 "description": "Message type s to return. If not populated - INFO, WARNING and ERROR\nmessages are returned." ,
557 "enum": [ 520 "enum": [
558 "TRANSFER_STATUS_UNSPECI FIED", 521 "MESSAGE_SEVERITY_UNSPEC IFIED",
559 "INACTIVE", 522 "INFO",
560 "PENDING", 523 "WARNING",
561 "RUNNING", 524 "ERROR"
562 "SUCCEEDED",
563 "FAILED",
564 "CANCELLED"
565 ], 525 ],
566 "location": "query", 526 "location": "query",
567 "repeated": true, 527 "repeated": true,
568 "type": "string" 528 "type": "string"
569 }, 529 },
570 "runAttempt": {
571 "description": "Indicates ho w run attempts are to be pulled.",
572 "enum": [
573 "RUN_ATTEMPT_UNSPECIFIED ",
574 "LATEST"
575 ],
576 "location": "query",
577 "type": "string"
578 },
579 "parent": { 530 "parent": {
580 "description": "Name of tran sfer configuration for which transfer runs should be retrieved.\nFormat of trans fer configuration resource name is:\n`projects/{project_id}/transferConfigs/{con fig_id}`.", 531 "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run _id}`.",
581 "location": "path", 532 "location": "path",
582 "pattern": "^projects/[^/]+/ locations/[^/]+/transferConfigs/[^/]+$", 533 "pattern": "^projects/[^/]+/ transferConfigs/[^/]+/runs/[^/]+$",
583 "required": true, 534 "required": true,
584 "type": "string" 535 "type": "string"
585 } 536 }
586 }, 537 },
587 "path": "v1/{+parent}/runs", 538 "path": "v1/{+parent}/transferLogs",
588 "response": { 539 "response": {
589 "$ref": "ListTransferRunsRespons e" 540 "$ref": "ListTransferLogsRespons e"
590 }, 541 },
591 "scopes": [ 542 "scopes": [
592 "https://www.googleapis.com/auth /bigquery", 543 "https://www.googleapis.com/auth /bigquery",
593 "https://www.googleapis.com/auth /cloud-platform",
594 "https://www.googleapis.com/auth /cloud-platform.read-only"
595 ]
596 },
597 "get": {
598 "description": "Returns information about the particular transfer run.",
599 "httpMethod": "GET",
600 "id": "bigquerydatatransfer.projects .locations.transferConfigs.runs.get",
601 "parameterOrder": [
602 "name"
603 ],
604 "parameters": {
605 "name": {
606 "description": "The field wi ll contain name of the resource requested, for example:\n`projects/{project_id}/ transferConfigs/{config_id}/runs/{run_id}`",
607 "location": "path",
608 "pattern": "^projects/[^/]+/ locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
609 "required": true,
610 "type": "string"
611 }
612 },
613 "path": "v1/{+name}",
614 "response": {
615 "$ref": "TransferRun"
616 },
617 "scopes": [
618 "https://www.googleapis.com/auth /bigquery",
619 "https://www.googleapis.com/auth /cloud-platform", 544 "https://www.googleapis.com/auth /cloud-platform",
620 "https://www.googleapis.com/auth /cloud-platform.read-only" 545 "https://www.googleapis.com/auth /cloud-platform.read-only"
621 ] 546 ]
622 } 547 }
623 },
624 "resources": {
625 "transferLogs": {
626 "methods": {
627 "list": {
628 "description": "Returns user facing log messages for the data transfer run.",
629 "httpMethod": "GET",
630 "id": "bigquerydatatransfer. projects.locations.transferConfigs.runs.transferLogs.list",
631 "parameterOrder": [
632 "parent"
633 ],
634 "parameters": {
635 "pageSize": {
636 "description": "Page size. The default page size is the maximum value of 1000 results.",
637 "format": "int32",
638 "location": "query",
639 "type": "integer"
640 },
641 "messageTypes": {
642 "description": "Mess age types to return. If not populated - INFO, WARNING and ERROR\nmessages are re turned.",
643 "enum": [
644 "MESSAGE_SEVERIT Y_UNSPECIFIED",
645 "INFO",
646 "WARNING",
647 "ERROR"
648 ],
649 "location": "query",
650 "repeated": true,
651 "type": "string"
652 },
653 "parent": {
654 "description": "Tran sfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/r uns/{run_id}`.",
655 "location": "path",
656 "pattern": "^project s/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
657 "required": true,
658 "type": "string"
659 },
660 "pageToken": {
661 "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.",
662 "location": "query",
663 "type": "string"
664 }
665 },
666 "path": "v1/{+parent}/transf erLogs",
667 "response": {
668 "$ref": "ListTransferLog sResponse"
669 },
670 "scopes": [
671 "https://www.googleapis. com/auth/bigquery",
672 "https://www.googleapis. com/auth/cloud-platform",
673 "https://www.googleapis. com/auth/cloud-platform.read-only"
674 ]
675 }
676 }
677 }
678 } 548 }
679 } 549 }
680 } 550 }
681 },
682 "dataSources": {
683 "methods": {
684 "list": {
685 "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
686 "httpMethod": "GET",
687 "id": "bigquerydatatransfer.projects.locatio ns.dataSources.list",
688 "parameterOrder": [
689 "parent"
690 ],
691 "parameters": {
692 "pageSize": {
693 "description": "Page size. The defau lt page size is the maximum value of 1000 results.",
694 "format": "int32",
695 "location": "query",
696 "type": "integer"
697 },
698 "parent": {
699 "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{ project_id}`",
700 "location": "path",
701 "pattern": "^projects/[^/]+/location s/[^/]+$",
702 "required": true,
703 "type": "string"
704 },
705 "pageToken": {
706 "description": "Pagination token, wh ich can be used to request a specific page\nof `ListDataSourcesRequest` list res ults. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_pag e` token, which can be used as the\n`page_token` value to request the next page of list results.",
707 "location": "query",
708 "type": "string"
709 }
710 },
711 "path": "v1/{+parent}/dataSources",
712 "response": {
713 "$ref": "ListDataSourcesResponse"
714 },
715 "scopes": [
716 "https://www.googleapis.com/auth/bigquer y",
717 "https://www.googleapis.com/auth/cloud-p latform",
718 "https://www.googleapis.com/auth/cloud-p latform.read-only"
719 ]
720 },
721 "get": {
722 "description": "Retrieves a supported data s ource and returns its settings,\nwhich can be used for UI rendering.",
723 "httpMethod": "GET",
724 "id": "bigquerydatatransfer.projects.locatio ns.dataSources.get",
725 "parameterOrder": [
726 "name"
727 ],
728 "parameters": {
729 "name": {
730 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/dataSour ces/{data_source_id}`",
731 "location": "path",
732 "pattern": "^projects/[^/]+/location s/[^/]+/dataSources/[^/]+$",
733 "required": true,
734 "type": "string"
735 }
736 },
737 "path": "v1/{+name}",
738 "response": {
739 "$ref": "DataSource"
740 },
741 "scopes": [
742 "https://www.googleapis.com/auth/bigquer y",
743 "https://www.googleapis.com/auth/cloud-p latform",
744 "https://www.googleapis.com/auth/cloud-p latform.read-only"
745 ]
746 },
747 "checkValidCreds": {
748 "description": "Returns true if valid creden tials exist for the given data source and\nrequesting user.",
749 "httpMethod": "POST",
750 "id": "bigquerydatatransfer.projects.locatio ns.dataSources.checkValidCreds",
751 "parameterOrder": [
752 "name"
753 ],
754 "parameters": {
755 "name": {
756 "description": "The data source in t he form:\n`projects/{project_id}/dataSources/{data_source_id}`",
757 "location": "path",
758 "pattern": "^projects/[^/]+/location s/[^/]+/dataSources/[^/]+$",
759 "required": true,
760 "type": "string"
761 }
762 },
763 "path": "v1/{+name}:checkValidCreds",
764 "request": {
765 "$ref": "CheckValidCredsRequest"
766 },
767 "response": {
768 "$ref": "CheckValidCredsResponse"
769 },
770 "scopes": [
771 "https://www.googleapis.com/auth/bigquer y",
772 "https://www.googleapis.com/auth/cloud-p latform",
773 "https://www.googleapis.com/auth/cloud-p latform.read-only"
774 ]
775 }
776 }
777 } 551 }
778 } 552 }
779 }, 553 },
780 "transferConfigs": { 554 "dataSources": {
781 "methods": { 555 "methods": {
782 "delete": { 556 "checkValidCreds": {
783 "description": "Deletes a data transfer configuratio n,\nincluding any associated transfer runs and logs.", 557 "description": "Returns true if valid credentials ex ist for the given data source and\nrequesting user.",
784 "httpMethod": "DELETE", 558 "httpMethod": "POST",
785 "id": "bigquerydatatransfer.projects.transferConfigs .delete", 559 "id": "bigquerydatatransfer.projects.dataSources.che ckValidCreds",
786 "parameterOrder": [ 560 "parameterOrder": [
787 "name" 561 "name"
788 ], 562 ],
789 "parameters": { 563 "parameters": {
790 "name": { 564 "name": {
791 "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/ {config_id}`", 565 "description": "The data source in the form: \n`projects/{project_id}/dataSources/{data_source_id}`",
792 "location": "path", 566 "location": "path",
793 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$", 567 "pattern": "^projects/[^/]+/dataSources/[^/] +$",
794 "required": true, 568 "required": true,
795 "type": "string" 569 "type": "string"
796 } 570 }
797 }, 571 },
798 "path": "v1/{+name}", 572 "path": "v1/{+name}:checkValidCreds",
573 "request": {
574 "$ref": "CheckValidCredsRequest"
575 },
799 "response": { 576 "response": {
800 "$ref": "Empty" 577 "$ref": "CheckValidCredsResponse"
801 }, 578 },
802 "scopes": [ 579 "scopes": [
803 "https://www.googleapis.com/auth/bigquery", 580 "https://www.googleapis.com/auth/bigquery",
804 "https://www.googleapis.com/auth/cloud-platform" 581 "https://www.googleapis.com/auth/cloud-platform" ,
582 "https://www.googleapis.com/auth/cloud-platform. read-only"
805 ] 583 ]
806 }, 584 },
807 "list": { 585 "list": {
808 "description": "Returns information about all data t ransfers in the project.", 586 "description": "Lists supported data sources and ret urns their settings,\nwhich can be used for UI rendering.",
809 "httpMethod": "GET", 587 "httpMethod": "GET",
810 "id": "bigquerydatatransfer.projects.transferConfigs .list", 588 "id": "bigquerydatatransfer.projects.dataSources.lis t",
811 "parameterOrder": [ 589 "parameterOrder": [
812 "parent" 590 "parent"
813 ], 591 ],
814 "parameters": { 592 "parameters": {
815 "pageToken": { 593 "pageToken": {
816 "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.", 594 "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. Fo r multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token , which can be used as the\n`page_token` value to request the next page of list results.",
817 "location": "query", 595 "location": "query",
818 "type": "string" 596 "type": "string"
819 }, 597 },
820 "pageSize": { 598 "pageSize": {
821 "description": "Page size. The default page size is the maximum value of 1000 results.", 599 "description": "Page size. The default page size is the maximum value of 1000 results.",
822 "format": "int32", 600 "format": "int32",
823 "location": "query", 601 "location": "query",
824 "type": "integer" 602 "type": "integer"
825 }, 603 },
826 "dataSourceIds": {
827 "description": "When specified, only configu rations of requested data sources are returned.",
828 "location": "query",
829 "repeated": true,
830 "type": "string"
831 },
832 "parent": { 604 "parent": {
833 "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.", 605 "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_ id}`",
834 "location": "path", 606 "location": "path",
835 "pattern": "^projects/[^/]+$", 607 "pattern": "^projects/[^/]+$",
836 "required": true, 608 "required": true,
837 "type": "string" 609 "type": "string"
838 } 610 }
839 }, 611 },
840 "path": "v1/{+parent}/transferConfigs", 612 "path": "v1/{+parent}/dataSources",
841 "response": { 613 "response": {
842 "$ref": "ListTransferConfigsResponse" 614 "$ref": "ListDataSourcesResponse"
843 }, 615 },
844 "scopes": [ 616 "scopes": [
845 "https://www.googleapis.com/auth/bigquery", 617 "https://www.googleapis.com/auth/bigquery",
846 "https://www.googleapis.com/auth/cloud-platform" , 618 "https://www.googleapis.com/auth/cloud-platform" ,
847 "https://www.googleapis.com/auth/cloud-platform. read-only" 619 "https://www.googleapis.com/auth/cloud-platform. read-only"
848 ] 620 ]
849 }, 621 },
850 "create": { 622 "get": {
851 "description": "Creates a new data transfer configur ation.", 623 "description": "Retrieves a supported data source an d returns its settings,\nwhich can be used for UI rendering.",
852 "httpMethod": "POST", 624 "httpMethod": "GET",
853 "id": "bigquerydatatransfer.projects.transferConfigs .create", 625 "id": "bigquerydatatransfer.projects.dataSources.get ",
854 "parameterOrder": [
855 "parent"
856 ],
857 "parameters": {
858 "authorizationCode": {
859 "description": "Optional OAuth2 authorizatio n code to use with this transfer configuration.\nThis is required if new credent ials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authori zation_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatran sfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>& redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* dat a_source_scopes are the scopes returned by ListDataSources method.\n* redirect_u ri is an optional parameter. If not specified, then\n authorization code is pos ted 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 aut horization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application .",
860 "location": "query",
861 "type": "string"
862 },
863 "parent": {
864 "description": "The BigQuery project id wher e the transfer configuration should be created.\nMust be in the format /projects /{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nI n case when '-' is specified as location_id, location is infered from\nthe desti nation dataset region.",
865 "location": "path",
866 "pattern": "^projects/[^/]+$",
867 "required": true,
868 "type": "string"
869 }
870 },
871 "path": "v1/{+parent}/transferConfigs",
872 "request": {
873 "$ref": "TransferConfig"
874 },
875 "response": {
876 "$ref": "TransferConfig"
877 },
878 "scopes": [
879 "https://www.googleapis.com/auth/bigquery",
880 "https://www.googleapis.com/auth/cloud-platform"
881 ]
882 },
883 "scheduleRuns": {
884 "description": "Creates transfer runs for a time ran ge [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote tha t runs are created per UTC time in the time range.",
885 "httpMethod": "POST",
886 "id": "bigquerydatatransfer.projects.transferConfigs .scheduleRuns",
887 "parameterOrder": [
888 "parent"
889 ],
890 "parameters": {
891 "parent": {
892 "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
893 "location": "path",
894 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
895 "required": true,
896 "type": "string"
897 }
898 },
899 "path": "v1/{+parent}:scheduleRuns",
900 "request": {
901 "$ref": "ScheduleTransferRunsRequest"
902 },
903 "response": {
904 "$ref": "ScheduleTransferRunsResponse"
905 },
906 "scopes": [
907 "https://www.googleapis.com/auth/bigquery",
908 "https://www.googleapis.com/auth/cloud-platform"
909 ]
910 },
911 "patch": {
912 "description": "Updates a data transfer configuratio n.\nAll fields must be set, even if they are not updated.",
913 "httpMethod": "PATCH",
914 "id": "bigquerydatatransfer.projects.transferConfigs .patch",
915 "parameterOrder": [ 626 "parameterOrder": [
916 "name" 627 "name"
917 ], 628 ],
918 "parameters": { 629 "parameters": {
919 "name": { 630 "name": {
920 "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.", 631 "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{dat a_source_id}`",
921 "location": "path", 632 "location": "path",
922 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$", 633 "pattern": "^projects/[^/]+/dataSources/[^/] +$",
923 "required": true,
924 "type": "string"
925 },
926 "authorizationCode": {
927 "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.",
928 "location": "query",
929 "type": "string"
930 },
931 "updateMask": {
932 "description": "Required list of fields to b e updated in this request.",
933 "format": "google-fieldmask",
934 "location": "query",
935 "type": "string"
936 }
937 },
938 "path": "v1/{+name}",
939 "request": {
940 "$ref": "TransferConfig"
941 },
942 "response": {
943 "$ref": "TransferConfig"
944 },
945 "scopes": [
946 "https://www.googleapis.com/auth/bigquery",
947 "https://www.googleapis.com/auth/cloud-platform"
948 ]
949 },
950 "get": {
951 "description": "Returns information about a data tra nsfer config.",
952 "httpMethod": "GET",
953 "id": "bigquerydatatransfer.projects.transferConfigs .get",
954 "parameterOrder": [
955 "name"
956 ],
957 "parameters": {
958 "name": {
959 "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/ {config_id}`",
960 "location": "path",
961 "pattern": "^projects/[^/]+/transferConfigs/ [^/]+$",
962 "required": true, 634 "required": true,
963 "type": "string" 635 "type": "string"
964 } 636 }
965 }, 637 },
966 "path": "v1/{+name}", 638 "path": "v1/{+name}",
967 "response": { 639 "response": {
968 "$ref": "TransferConfig" 640 "$ref": "DataSource"
969 }, 641 },
970 "scopes": [ 642 "scopes": [
971 "https://www.googleapis.com/auth/bigquery", 643 "https://www.googleapis.com/auth/bigquery",
644 "https://www.googleapis.com/auth/cloud-platform" ,
645 "https://www.googleapis.com/auth/cloud-platform. read-only"
646 ]
647 }
648 }
649 },
650 "locations": {
651 "methods": {
652 "isEnabled": {
653 "description": "Returns true if data transfer is ena bled for a project.",
654 "httpMethod": "POST",
655 "id": "bigquerydatatransfer.projects.locations.isEna bled",
656 "parameterOrder": [
657 "name"
658 ],
659 "parameters": {
660 "name": {
661 "description": "The name of the project reso urce in the form:\n`projects/{project_id}`",
662 "location": "path",
663 "pattern": "^projects/[^/]+/locations/[^/]+$ ",
664 "required": true,
665 "type": "string"
666 }
667 },
668 "path": "v1/{+name}:isEnabled",
669 "request": {
670 "$ref": "IsEnabledRequest"
671 },
672 "response": {
673 "$ref": "IsEnabledResponse"
674 },
675 "scopes": [
676 "https://www.googleapis.com/auth/bigquery",
677 "https://www.googleapis.com/auth/cloud-platform" ,
678 "https://www.googleapis.com/auth/cloud-platform. read-only"
679 ]
680 },
681 "setEnabled": {
682 "description": "Enables or disables data transfer fo r a project. This\nmethod requires the additional scope of\n'https://www.googlea pis.com/auth/cloudplatformprojects'\nto manage the cloud project permissions.",
683 "httpMethod": "POST",
684 "id": "bigquerydatatransfer.projects.locations.setEn abled",
685 "parameterOrder": [
686 "name"
687 ],
688 "parameters": {
689 "name": {
690 "description": "The name of the project reso urce in the form:\n`projects/{project_id}`",
691 "location": "path",
692 "pattern": "^projects/[^/]+/locations/[^/]+$ ",
693 "required": true,
694 "type": "string"
695 }
696 },
697 "path": "v1/{+name}:setEnabled",
698 "request": {
699 "$ref": "SetEnabledRequest"
700 },
701 "response": {
702 "$ref": "Empty"
703 },
704 "scopes": [
705 "https://www.googleapis.com/auth/cloud-platform"
706 ]
707 },
708 "get": {
709 "description": "Get information about a location.",
710 "httpMethod": "GET",
711 "id": "bigquerydatatransfer.projects.locations.get",
712 "parameterOrder": [
713 "name"
714 ],
715 "parameters": {
716 "name": {
717 "description": "Resource name for the locati on.",
718 "location": "path",
719 "pattern": "^projects/[^/]+/locations/[^/]+$ ",
720 "required": true,
721 "type": "string"
722 }
723 },
724 "path": "v1/{+name}",
725 "response": {
726 "$ref": "Location"
727 },
728 "scopes": [
729 "https://www.googleapis.com/auth/bigquery",
730 "https://www.googleapis.com/auth/cloud-platform" ,
731 "https://www.googleapis.com/auth/cloud-platform. read-only"
732 ]
733 },
734 "list": {
735 "description": "Lists information about the supporte d locations for this service.",
736 "httpMethod": "GET",
737 "id": "bigquerydatatransfer.projects.locations.list" ,
738 "parameterOrder": [
739 "name"
740 ],
741 "parameters": {
742 "filter": {
743 "description": "The standard list filter.",
744 "location": "query",
745 "type": "string"
746 },
747 "pageToken": {
748 "description": "The standard list page token .",
749 "location": "query",
750 "type": "string"
751 },
752 "name": {
753 "description": "The resource that owns the l ocations collection, if applicable.",
754 "location": "path",
755 "pattern": "^projects/[^/]+$",
756 "required": true,
757 "type": "string"
758 },
759 "pageSize": {
760 "description": "The standard list page size. ",
761 "format": "int32",
762 "location": "query",
763 "type": "integer"
764 }
765 },
766 "path": "v1/{+name}/locations",
767 "response": {
768 "$ref": "ListLocationsResponse"
769 },
770 "scopes": [
771 "https://www.googleapis.com/auth/bigquery",
972 "https://www.googleapis.com/auth/cloud-platform" , 772 "https://www.googleapis.com/auth/cloud-platform" ,
973 "https://www.googleapis.com/auth/cloud-platform. read-only" 773 "https://www.googleapis.com/auth/cloud-platform. read-only"
974 ] 774 ]
975 } 775 }
976 }, 776 },
977 "resources": { 777 "resources": {
978 "runs": { 778 "transferConfigs": {
979 "methods": { 779 "methods": {
980 "delete": { 780 "delete": {
981 "description": "Deletes the specified transf er run.", 781 "description": "Deletes a data transfer conf iguration,\nincluding any associated transfer runs and logs.",
982 "httpMethod": "DELETE", 782 "httpMethod": "DELETE",
983 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.delete", 783 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.delete",
984 "parameterOrder": [ 784 "parameterOrder": [
985 "name" 785 "name"
986 ], 786 ],
987 "parameters": { 787 "parameters": {
988 "name": { 788 "name": {
989 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}/runs/{run_id}`", 789 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}`",
990 "location": "path", 790 "location": "path",
991 "pattern": "^projects/[^/]+/transfer Configs/[^/]+/runs/[^/]+$", 791 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
992 "required": true, 792 "required": true,
993 "type": "string" 793 "type": "string"
994 } 794 }
995 }, 795 },
996 "path": "v1/{+name}", 796 "path": "v1/{+name}",
997 "response": { 797 "response": {
998 "$ref": "Empty" 798 "$ref": "Empty"
999 }, 799 },
1000 "scopes": [ 800 "scopes": [
1001 "https://www.googleapis.com/auth/bigquer y", 801 "https://www.googleapis.com/auth/bigquer y",
1002 "https://www.googleapis.com/auth/cloud-p latform" 802 "https://www.googleapis.com/auth/cloud-p latform"
1003 ] 803 ]
1004 }, 804 },
1005 "list": { 805 "list": {
1006 "description": "Returns information about ru nning and completed jobs.", 806 "description": "Returns information about al l data transfers in the project.",
1007 "httpMethod": "GET", 807 "httpMethod": "GET",
1008 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.list", 808 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.list",
1009 "parameterOrder": [ 809 "parameterOrder": [
1010 "parent" 810 "parent"
1011 ], 811 ],
1012 "parameters": { 812 "parameters": {
813 "dataSourceIds": {
814 "description": "When specified, only configurations of requested data sources are returned.",
815 "location": "query",
816 "repeated": true,
817 "type": "string"
818 },
819 "parent": {
820 "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
821 "location": "path",
822 "pattern": "^projects/[^/]+/location s/[^/]+$",
823 "required": true,
824 "type": "string"
825 },
1013 "pageToken": { 826 "pageToken": {
1014 "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.", 827 "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.",
1015 "location": "query", 828 "location": "query",
1016 "type": "string" 829 "type": "string"
1017 }, 830 },
1018 "pageSize": { 831 "pageSize": {
1019 "description": "Page size. The defau lt page size is the maximum value of 1000 results.", 832 "description": "Page size. The defau lt page size is the maximum value of 1000 results.",
1020 "format": "int32", 833 "format": "int32",
1021 "location": "query", 834 "location": "query",
1022 "type": "integer" 835 "type": "integer"
1023 },
1024 "statuses": {
1025 "description": "When specified, only transfer runs with requested statuses are returned.",
1026 "enum": [
1027 "TRANSFER_STATUS_UNSPECIFIED",
1028 "INACTIVE",
1029 "PENDING",
1030 "RUNNING",
1031 "SUCCEEDED",
1032 "FAILED",
1033 "CANCELLED"
1034 ],
1035 "location": "query",
1036 "repeated": true,
1037 "type": "string"
1038 },
1039 "runAttempt": {
1040 "description": "Indicates how run at tempts are to be pulled.",
1041 "enum": [
1042 "RUN_ATTEMPT_UNSPECIFIED",
1043 "LATEST"
1044 ],
1045 "location": "query",
1046 "type": "string"
1047 },
1048 "parent": {
1049 "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}` .",
1050 "location": "path",
1051 "pattern": "^projects/[^/]+/transfer Configs/[^/]+$",
1052 "required": true,
1053 "type": "string"
1054 } 836 }
1055 }, 837 },
1056 "path": "v1/{+parent}/runs", 838 "path": "v1/{+parent}/transferConfigs",
1057 "response": { 839 "response": {
1058 "$ref": "ListTransferRunsResponse" 840 "$ref": "ListTransferConfigsResponse"
1059 }, 841 },
1060 "scopes": [ 842 "scopes": [
1061 "https://www.googleapis.com/auth/bigquer y", 843 "https://www.googleapis.com/auth/bigquer y",
1062 "https://www.googleapis.com/auth/cloud-p latform", 844 "https://www.googleapis.com/auth/cloud-p latform",
1063 "https://www.googleapis.com/auth/cloud-p latform.read-only" 845 "https://www.googleapis.com/auth/cloud-p latform.read-only"
1064 ] 846 ]
1065 }, 847 },
1066 "get": { 848 "create": {
1067 "description": "Returns information about th e particular transfer run.", 849 "description": "Creates a new data transfer configuration.",
1068 "httpMethod": "GET", 850 "httpMethod": "POST",
1069 "id": "bigquerydatatransfer.projects.transfe rConfigs.runs.get", 851 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.create",
852 "parameterOrder": [
853 "parent"
854 ],
855 "parameters": {
856 "parent": {
857 "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format / projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locati ons/-\nIn case when '-' is specified as location_id, location is infered from\nt he destination dataset region.",
858 "location": "path",
859 "pattern": "^projects/[^/]+/location s/[^/]+$",
860 "required": true,
861 "type": "string"
862 },
863 "authorizationCode": {
864 "description": "Optional OAuth2 auth orization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquery datatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_ scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method .\n* data_source_scopes are the scopes returned by ListDataSources method.\n* re direct_uri is an optional parameter. If not specified, then\n authorization cod e 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 title bar of the browser, w ith the page text prompting\n the user to copy the code and paste it in the app lication.",
865 "location": "query",
866 "type": "string"
867 }
868 },
869 "path": "v1/{+parent}/transferConfigs",
870 "request": {
871 "$ref": "TransferConfig"
872 },
873 "response": {
874 "$ref": "TransferConfig"
875 },
876 "scopes": [
877 "https://www.googleapis.com/auth/bigquer y",
878 "https://www.googleapis.com/auth/cloud-p latform"
879 ]
880 },
881 "scheduleRuns": {
882 "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever gran ularity the data source supports - in the\nrange, one transfer run is created.\n Note that runs are created per UTC time in the time range.",
883 "httpMethod": "POST",
884 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.scheduleRuns",
885 "parameterOrder": [
886 "parent"
887 ],
888 "parameters": {
889 "parent": {
890 "description": "Transfer configurati on name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
891 "location": "path",
892 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
893 "required": true,
894 "type": "string"
895 }
896 },
897 "path": "v1/{+parent}:scheduleRuns",
898 "request": {
899 "$ref": "ScheduleTransferRunsRequest"
900 },
901 "response": {
902 "$ref": "ScheduleTransferRunsResponse"
903 },
904 "scopes": [
905 "https://www.googleapis.com/auth/bigquer y",
906 "https://www.googleapis.com/auth/cloud-p latform"
907 ]
908 },
909 "patch": {
910 "description": "Updates a data transfer conf iguration.\nAll fields must be set, even if they are not updated.",
911 "httpMethod": "PATCH",
912 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.patch",
1070 "parameterOrder": [ 913 "parameterOrder": [
1071 "name" 914 "name"
1072 ], 915 ],
1073 "parameters": { 916 "parameters": {
1074 "name": { 917 "name": {
1075 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}/runs/{run_id}`", 918 "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 .",
1076 "location": "path", 919 "location": "path",
1077 "pattern": "^projects/[^/]+/transfer Configs/[^/]+/runs/[^/]+$", 920 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
921 "required": true,
922 "type": "string"
923 },
924 "authorizationCode": {
925 "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.",
926 "location": "query",
927 "type": "string"
928 },
929 "updateMask": {
930 "description": "Required list of fie lds to be updated in this request.",
931 "format": "google-fieldmask",
932 "location": "query",
933 "type": "string"
934 }
935 },
936 "path": "v1/{+name}",
937 "request": {
938 "$ref": "TransferConfig"
939 },
940 "response": {
941 "$ref": "TransferConfig"
942 },
943 "scopes": [
944 "https://www.googleapis.com/auth/bigquer y",
945 "https://www.googleapis.com/auth/cloud-p latform"
946 ]
947 },
948 "get": {
949 "description": "Returns information about a data transfer config.",
950 "httpMethod": "GET",
951 "id": "bigquerydatatransfer.projects.locatio ns.transferConfigs.get",
952 "parameterOrder": [
953 "name"
954 ],
955 "parameters": {
956 "name": {
957 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/transfer Configs/{config_id}`",
958 "location": "path",
959 "pattern": "^projects/[^/]+/location s/[^/]+/transferConfigs/[^/]+$",
1078 "required": true, 960 "required": true,
1079 "type": "string" 961 "type": "string"
1080 } 962 }
1081 }, 963 },
1082 "path": "v1/{+name}", 964 "path": "v1/{+name}",
1083 "response": { 965 "response": {
1084 "$ref": "TransferRun" 966 "$ref": "TransferConfig"
1085 }, 967 },
1086 "scopes": [ 968 "scopes": [
1087 "https://www.googleapis.com/auth/bigquer y", 969 "https://www.googleapis.com/auth/bigquer y",
1088 "https://www.googleapis.com/auth/cloud-p latform", 970 "https://www.googleapis.com/auth/cloud-p latform",
1089 "https://www.googleapis.com/auth/cloud-p latform.read-only" 971 "https://www.googleapis.com/auth/cloud-p latform.read-only"
1090 ] 972 ]
1091 } 973 }
1092 }, 974 },
1093 "resources": { 975 "resources": {
1094 "transferLogs": { 976 "runs": {
1095 "methods": { 977 "methods": {
978 "delete": {
979 "description": "Deletes the specifie d transfer run.",
980 "httpMethod": "DELETE",
981 "id": "bigquerydatatransfer.projects .locations.transferConfigs.runs.delete",
982 "parameterOrder": [
983 "name"
984 ],
985 "parameters": {
986 "name": {
987 "description": "The field wi ll contain name of the resource requested, for example:\n`projects/{project_id}/ transferConfigs/{config_id}/runs/{run_id}`",
988 "location": "path",
989 "pattern": "^projects/[^/]+/ locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
990 "required": true,
991 "type": "string"
992 }
993 },
994 "path": "v1/{+name}",
995 "response": {
996 "$ref": "Empty"
997 },
998 "scopes": [
999 "https://www.googleapis.com/auth /bigquery",
1000 "https://www.googleapis.com/auth /cloud-platform"
1001 ]
1002 },
1096 "list": { 1003 "list": {
1097 "description": "Returns user facing log messages for the data transfer run.", 1004 "description": "Returns information about running and completed jobs.",
1098 "httpMethod": "GET", 1005 "httpMethod": "GET",
1099 "id": "bigquerydatatransfer.projects .transferConfigs.runs.transferLogs.list", 1006 "id": "bigquerydatatransfer.projects .locations.transferConfigs.runs.list",
1100 "parameterOrder": [ 1007 "parameterOrder": [
1101 "parent" 1008 "parent"
1102 ], 1009 ],
1103 "parameters": { 1010 "parameters": {
1011 "runAttempt": {
1012 "description": "Indicates ho w run attempts are to be pulled.",
1013 "enum": [
1014 "RUN_ATTEMPT_UNSPECIFIED ",
1015 "LATEST"
1016 ],
1017 "location": "query",
1018 "type": "string"
1019 },
1104 "parent": { 1020 "parent": {
1105 "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run _id}`.", 1021 "description": "Name of tran sfer configuration for which transfer runs should be retrieved.\nFormat of trans fer configuration resource name is:\n`projects/{project_id}/transferConfigs/{con fig_id}`.",
1106 "location": "path", 1022 "location": "path",
1107 "pattern": "^projects/[^/]+/ transferConfigs/[^/]+/runs/[^/]+$", 1023 "pattern": "^projects/[^/]+/ locations/[^/]+/transferConfigs/[^/]+$",
1108 "required": true, 1024 "required": true,
1109 "type": "string" 1025 "type": "string"
1110 }, 1026 },
1111 "pageToken": { 1027 "pageToken": {
1112 "description": "Pagination t oken, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", 1028 "description": "Pagination t oken, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
1113 "location": "query", 1029 "location": "query",
1114 "type": "string" 1030 "type": "string"
1115 }, 1031 },
1116 "pageSize": { 1032 "pageSize": {
1117 "description": "Page size. T he default page size is the maximum value of 1000 results.", 1033 "description": "Page size. T he default page size is the maximum value of 1000 results.",
1118 "format": "int32", 1034 "format": "int32",
1119 "location": "query", 1035 "location": "query",
1120 "type": "integer" 1036 "type": "integer"
1121 }, 1037 },
1122 "messageTypes": { 1038 "states": {
1123 "description": "Message type s to return. If not populated - INFO, WARNING and ERROR\nmessages are returned." , 1039 "description": "When specifi ed, only transfer runs with requested states are returned.",
1124 "enum": [ 1040 "enum": [
1125 "MESSAGE_SEVERITY_UNSPEC IFIED", 1041 "TRANSFER_STATE_UNSPECIF IED",
1126 "INFO", 1042 "INACTIVE",
1127 "WARNING", 1043 "PENDING",
1128 "ERROR" 1044 "RUNNING",
1045 "SUCCEEDED",
1046 "FAILED",
1047 "CANCELLED"
1129 ], 1048 ],
1130 "location": "query", 1049 "location": "query",
1131 "repeated": true, 1050 "repeated": true,
1132 "type": "string" 1051 "type": "string"
1133 } 1052 }
1134 }, 1053 },
1135 "path": "v1/{+parent}/transferLogs", 1054 "path": "v1/{+parent}/runs",
1136 "response": { 1055 "response": {
1137 "$ref": "ListTransferLogsRespons e" 1056 "$ref": "ListTransferRunsRespons e"
1138 }, 1057 },
1139 "scopes": [ 1058 "scopes": [
1140 "https://www.googleapis.com/auth /bigquery", 1059 "https://www.googleapis.com/auth /bigquery",
1060 "https://www.googleapis.com/auth /cloud-platform",
1061 "https://www.googleapis.com/auth /cloud-platform.read-only"
1062 ]
1063 },
1064 "get": {
1065 "description": "Returns information about the particular transfer run.",
1066 "httpMethod": "GET",
1067 "id": "bigquerydatatransfer.projects .locations.transferConfigs.runs.get",
1068 "parameterOrder": [
1069 "name"
1070 ],
1071 "parameters": {
1072 "name": {
1073 "description": "The field wi ll contain name of the resource requested, for example:\n`projects/{project_id}/ transferConfigs/{config_id}/runs/{run_id}`",
1074 "location": "path",
1075 "pattern": "^projects/[^/]+/ locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
1076 "required": true,
1077 "type": "string"
1078 }
1079 },
1080 "path": "v1/{+name}",
1081 "response": {
1082 "$ref": "TransferRun"
1083 },
1084 "scopes": [
1085 "https://www.googleapis.com/auth /bigquery",
1141 "https://www.googleapis.com/auth /cloud-platform", 1086 "https://www.googleapis.com/auth /cloud-platform",
1142 "https://www.googleapis.com/auth /cloud-platform.read-only" 1087 "https://www.googleapis.com/auth /cloud-platform.read-only"
1143 ] 1088 ]
1144 } 1089 }
1090 },
1091 "resources": {
1092 "transferLogs": {
1093 "methods": {
1094 "list": {
1095 "description": "Returns user facing log messages for the data transfer run.",
1096 "httpMethod": "GET",
1097 "id": "bigquerydatatransfer. projects.locations.transferConfigs.runs.transferLogs.list",
1098 "parameterOrder": [
1099 "parent"
1100 ],
1101 "parameters": {
1102 "pageToken": {
1103 "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.",
1104 "location": "query",
1105 "type": "string"
1106 },
1107 "pageSize": {
1108 "description": "Page size. The default page size is the maximum value of 1000 results.",
1109 "format": "int32",
1110 "location": "query",
1111 "type": "integer"
1112 },
1113 "messageTypes": {
1114 "description": "Mess age types to return. If not populated - INFO, WARNING and ERROR\nmessages are re turned.",
1115 "enum": [
1116 "MESSAGE_SEVERIT Y_UNSPECIFIED",
1117 "INFO",
1118 "WARNING",
1119 "ERROR"
1120 ],
1121 "location": "query",
1122 "repeated": true,
1123 "type": "string"
1124 },
1125 "parent": {
1126 "description": "Tran sfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/r uns/{run_id}`.",
1127 "location": "path",
1128 "pattern": "^project s/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
1129 "required": true,
1130 "type": "string"
1131 }
1132 },
1133 "path": "v1/{+parent}/transf erLogs",
1134 "response": {
1135 "$ref": "ListTransferLog sResponse"
1136 },
1137 "scopes": [
1138 "https://www.googleapis. com/auth/bigquery",
1139 "https://www.googleapis. com/auth/cloud-platform",
1140 "https://www.googleapis. com/auth/cloud-platform.read-only"
1141 ]
1142 }
1143 }
1144 }
1145 } 1145 }
1146 } 1146 }
1147 } 1147 }
1148 },
1149 "dataSources": {
1150 "methods": {
1151 "list": {
1152 "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
1153 "httpMethod": "GET",
1154 "id": "bigquerydatatransfer.projects.locatio ns.dataSources.list",
1155 "parameterOrder": [
1156 "parent"
1157 ],
1158 "parameters": {
1159 "parent": {
1160 "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{ project_id}`",
1161 "location": "path",
1162 "pattern": "^projects/[^/]+/location s/[^/]+$",
1163 "required": true,
1164 "type": "string"
1165 },
1166 "pageToken": {
1167 "description": "Pagination token, wh ich can be used to request a specific page\nof `ListDataSourcesRequest` list res ults. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_pag e` token, which can be used as the\n`page_token` value to request the next page of list results.",
1168 "location": "query",
1169 "type": "string"
1170 },
1171 "pageSize": {
1172 "description": "Page size. The defau lt page size is the maximum value of 1000 results.",
1173 "format": "int32",
1174 "location": "query",
1175 "type": "integer"
1176 }
1177 },
1178 "path": "v1/{+parent}/dataSources",
1179 "response": {
1180 "$ref": "ListDataSourcesResponse"
1181 },
1182 "scopes": [
1183 "https://www.googleapis.com/auth/bigquer y",
1184 "https://www.googleapis.com/auth/cloud-p latform",
1185 "https://www.googleapis.com/auth/cloud-p latform.read-only"
1186 ]
1187 },
1188 "get": {
1189 "description": "Retrieves a supported data s ource and returns its settings,\nwhich can be used for UI rendering.",
1190 "httpMethod": "GET",
1191 "id": "bigquerydatatransfer.projects.locatio ns.dataSources.get",
1192 "parameterOrder": [
1193 "name"
1194 ],
1195 "parameters": {
1196 "name": {
1197 "description": "The field will conta in name of the resource requested, for example:\n`projects/{project_id}/dataSour ces/{data_source_id}`",
1198 "location": "path",
1199 "pattern": "^projects/[^/]+/location s/[^/]+/dataSources/[^/]+$",
1200 "required": true,
1201 "type": "string"
1202 }
1203 },
1204 "path": "v1/{+name}",
1205 "response": {
1206 "$ref": "DataSource"
1207 },
1208 "scopes": [
1209 "https://www.googleapis.com/auth/bigquer y",
1210 "https://www.googleapis.com/auth/cloud-p latform",
1211 "https://www.googleapis.com/auth/cloud-p latform.read-only"
1212 ]
1213 },
1214 "checkValidCreds": {
1215 "description": "Returns true if valid creden tials exist for the given data source and\nrequesting user.",
1216 "httpMethod": "POST",
1217 "id": "bigquerydatatransfer.projects.locatio ns.dataSources.checkValidCreds",
1218 "parameterOrder": [
1219 "name"
1220 ],
1221 "parameters": {
1222 "name": {
1223 "description": "The data source in t he form:\n`projects/{project_id}/dataSources/{data_source_id}`",
1224 "location": "path",
1225 "pattern": "^projects/[^/]+/location s/[^/]+/dataSources/[^/]+$",
1226 "required": true,
1227 "type": "string"
1228 }
1229 },
1230 "path": "v1/{+name}:checkValidCreds",
1231 "request": {
1232 "$ref": "CheckValidCredsRequest"
1233 },
1234 "response": {
1235 "$ref": "CheckValidCredsResponse"
1236 },
1237 "scopes": [
1238 "https://www.googleapis.com/auth/bigquer y",
1239 "https://www.googleapis.com/auth/cloud-p latform",
1240 "https://www.googleapis.com/auth/cloud-p latform.read-only"
1241 ]
1242 }
1243 }
1148 } 1244 }
1149 } 1245 }
1150 },
1151 "dataSources": {
1152 "methods": {
1153 "list": {
1154 "description": "Lists supported data sources and ret urns their settings,\nwhich can be used for UI rendering.",
1155 "httpMethod": "GET",
1156 "id": "bigquerydatatransfer.projects.dataSources.lis t",
1157 "parameterOrder": [
1158 "parent"
1159 ],
1160 "parameters": {
1161 "parent": {
1162 "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_ id}`",
1163 "location": "path",
1164 "pattern": "^projects/[^/]+$",
1165 "required": true,
1166 "type": "string"
1167 },
1168 "pageToken": {
1169 "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. Fo r multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token , which can be used as the\n`page_token` value to request the next page of list results.",
1170 "location": "query",
1171 "type": "string"
1172 },
1173 "pageSize": {
1174 "description": "Page size. The default page size is the maximum value of 1000 results.",
1175 "format": "int32",
1176 "location": "query",
1177 "type": "integer"
1178 }
1179 },
1180 "path": "v1/{+parent}/dataSources",
1181 "response": {
1182 "$ref": "ListDataSourcesResponse"
1183 },
1184 "scopes": [
1185 "https://www.googleapis.com/auth/bigquery",
1186 "https://www.googleapis.com/auth/cloud-platform" ,
1187 "https://www.googleapis.com/auth/cloud-platform. read-only"
1188 ]
1189 },
1190 "get": {
1191 "description": "Retrieves a supported data source an d returns its settings,\nwhich can be used for UI rendering.",
1192 "httpMethod": "GET",
1193 "id": "bigquerydatatransfer.projects.dataSources.get ",
1194 "parameterOrder": [
1195 "name"
1196 ],
1197 "parameters": {
1198 "name": {
1199 "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{dat a_source_id}`",
1200 "location": "path",
1201 "pattern": "^projects/[^/]+/dataSources/[^/] +$",
1202 "required": true,
1203 "type": "string"
1204 }
1205 },
1206 "path": "v1/{+name}",
1207 "response": {
1208 "$ref": "DataSource"
1209 },
1210 "scopes": [
1211 "https://www.googleapis.com/auth/bigquery",
1212 "https://www.googleapis.com/auth/cloud-platform" ,
1213 "https://www.googleapis.com/auth/cloud-platform. read-only"
1214 ]
1215 },
1216 "checkValidCreds": {
1217 "description": "Returns true if valid credentials ex ist for the given data source and\nrequesting user.",
1218 "httpMethod": "POST",
1219 "id": "bigquerydatatransfer.projects.dataSources.che ckValidCreds",
1220 "parameterOrder": [
1221 "name"
1222 ],
1223 "parameters": {
1224 "name": {
1225 "description": "The data source in the form: \n`projects/{project_id}/dataSources/{data_source_id}`",
1226 "location": "path",
1227 "pattern": "^projects/[^/]+/dataSources/[^/] +$",
1228 "required": true,
1229 "type": "string"
1230 }
1231 },
1232 "path": "v1/{+name}:checkValidCreds",
1233 "request": {
1234 "$ref": "CheckValidCredsRequest"
1235 },
1236 "response": {
1237 "$ref": "CheckValidCredsResponse"
1238 },
1239 "scopes": [
1240 "https://www.googleapis.com/auth/bigquery",
1241 "https://www.googleapis.com/auth/cloud-platform" ,
1242 "https://www.googleapis.com/auth/cloud-platform. read-only"
1243 ]
1244 }
1245 }
1246 } 1246 }
1247 } 1247 }
1248 } 1248 }
1249 }, 1249 },
1250 "revision": "20170819", 1250 "revision": "20170909",
1251 "rootUrl": "https://bigquerydatatransfer.googleapis.com/", 1251 "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
1252 "schemas": { 1252 "schemas": {
1253 "ListTransferConfigsResponse": {
1254 "description": "The returned list of pipelines in the project.",
1255 "id": "ListTransferConfigsResponse",
1256 "properties": {
1257 "transferConfigs": {
1258 "description": "The stored pipeline transfer configurations. \nOutput only.",
1259 "items": {
1260 "$ref": "TransferConfig"
1261 },
1262 "type": "array"
1263 },
1264 "nextPageToken": {
1265 "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.\nOutput only.",
1266 "type": "string"
1267 }
1268 },
1269 "type": "object"
1270 },
1271 "SetEnabledRequest": {
1272 "description": "A request to set whether data transfer is enabled or disabled for a project.",
1273 "id": "SetEnabledRequest",
1274 "properties": {
1275 "enabled": {
1276 "description": "Whether data transfer should be enabled or d isabled for the project.",
1277 "type": "boolean"
1278 }
1279 },
1280 "type": "object"
1281 },
1282 "IsEnabledResponse": {
1283 "description": "A response to indicate whether data transfer is enab led for the project.",
1284 "id": "IsEnabledResponse",
1285 "properties": {
1286 "enabled": {
1287 "description": "Indicates whether the project is enabled.",
1288 "type": "boolean"
1289 }
1290 },
1291 "type": "object"
1292 },
1293 "DataSource": {
1294 "description": "Represents data source metadata. Metadata is suffici ent to\nrender UI and request proper OAuth tokens.",
1295 "id": "DataSource",
1296 "properties": {
1297 "description": {
1298 "description": "User friendly data source description string .",
1299 "type": "string"
1300 },
1301 "dataSourceId": {
1302 "description": "Data source id.",
1303 "type": "string"
1304 },
1305 "name": {
1306 "description": "Data source resource name.",
1307 "type": "string"
1308 },
1309 "scopes": {
1310 "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",
1311 "items": {
1312 "type": "string"
1313 },
1314 "type": "array"
1315 },
1316 "minimumScheduleInterval": {
1317 "description": "The minimum interval between two consecutive scheduled runs.",
1318 "format": "google-duration",
1319 "type": "string"
1320 },
1321 "clientId": {
1322 "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.",
1323 "type": "string"
1324 },
1325 "authorizationType": {
1326 "description": "Indicates the type of authorization.",
1327 "enum": [
1328 "AUTHORIZATION_TYPE_UNSPECIFIED",
1329 "AUTHORIZATION_CODE",
1330 "GOOGLE_PLUS_AUTHORIZATION_CODE"
1331 ],
1332 "enumDescriptions": [
1333 "Type unspecified.",
1334 "Use OAuth 2 authorization codes that can be exchanged\n for a refresh token on the backend.",
1335 "Return an authorization code for a given Google+ page t hat can then be\nexchanged for a refresh token on the backend."
1336 ],
1337 "type": "string"
1338 },
1339 "supportsCustomSchedule": {
1340 "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.",
1341 "type": "boolean"
1342 },
1343 "displayName": {
1344 "description": "User friendly data source name.",
1345 "type": "string"
1346 },
1347 "updateDeadlineSeconds": {
1348 "description": "The number of seconds to wait for an update from the data source\nbefore BigQuery marks the transfer as failed.",
1349 "format": "int32",
1350 "type": "integer"
1351 },
1352 "dataRefreshType": {
1353 "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.",
1354 "enum": [
1355 "DATA_REFRESH_TYPE_UNSPECIFIED",
1356 "SLIDING_WINDOW",
1357 "CUSTOM_SLIDING_WINDOW"
1358 ],
1359 "enumDescriptions": [
1360 "The data source won't support data auto refresh, which is default value.",
1361 "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.",
1362 "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."
1363 ],
1364 "type": "string"
1365 },
1366 "parameters": {
1367 "description": "Data source parameters.",
1368 "items": {
1369 "$ref": "DataSourceParameter"
1370 },
1371 "type": "array"
1372 },
1373 "helpUrl": {
1374 "description": "Url for the help document for this data sour ce.",
1375 "type": "string"
1376 },
1377 "defaultSchedule": {
1378 "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`.",
1379 "type": "string"
1380 },
1381 "supportsMultipleTransfers": {
1382 "description": "Indicates whether the data source supports m ultiple transfers\nto different BigQuery targets.",
1383 "type": "boolean"
1384 },
1385 "manualRunsDisabled": {
1386 "description": "Disables backfilling and manual run scheduli ng\nfor the data source.",
1387 "type": "boolean"
1388 },
1389 "defaultDataRefreshWindowDays": {
1390 "description": "Default data refresh window on days.\nOnly m eaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
1391 "format": "int32",
1392 "type": "integer"
1393 },
1394 "transferType": {
1395 "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.",
1396 "enum": [
1397 "TRANSFER_TYPE_UNSPECIFIED",
1398 "BATCH",
1399 "STREAMING"
1400 ],
1401 "enumDescriptions": [
1402 "Invalid or Unknown transfer type placeholder.",
1403 "Batch data transfer.",
1404 "Streaming data transfer. Streaming data source currentl y doesn't\nsupport multiple transfer configs per project."
1405 ],
1406 "type": "string"
1407 }
1408 },
1409 "type": "object"
1410 },
1411 "ScheduleTransferRunsRequest": {
1412 "description": "A request to schedule transfer runs for a time range .",
1413 "id": "ScheduleTransferRunsRequest",
1414 "properties": {
1415 "rangeStartTime": {
1416 "description": "Start time of the range of transfer runs.",
1417 "format": "google-datetime",
1418 "type": "string"
1419 },
1420 "rangeEndTime": {
1421 "description": "End time of the range of transfer runs.",
1422 "format": "google-datetime",
1423 "type": "string"
1424 }
1425 },
1426 "type": "object"
1427 },
1428 "Empty": {
1429 "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 `{}`.",
1430 "id": "Empty",
1431 "properties": {},
1432 "type": "object"
1433 },
1253 "Location": { 1434 "Location": {
1254 "description": "A resource that represents Google Cloud Platform loc ation.", 1435 "description": "A resource that represents Google Cloud Platform loc ation.",
1255 "id": "Location", 1436 "id": "Location",
1256 "properties": { 1437 "properties": {
1257 "labels": {
1258 "additionalProperties": {
1259 "type": "string"
1260 },
1261 "description": "Cross-service attributes for the location. F or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
1262 "type": "object"
1263 },
1264 "name": {
1265 "description": "Resource name for the location, which may va ry between implementations.\nFor example: `\"projects/example-project/locations/ us-east1\"`",
1266 "type": "string"
1267 },
1268 "locationId": { 1438 "locationId": {
1269 "description": "The canonical id for this location. For exam ple: `\"us-east1\"`.", 1439 "description": "The canonical id for this location. For exam ple: `\"us-east1\"`.",
1270 "type": "string" 1440 "type": "string"
1271 }, 1441 },
1272 "metadata": { 1442 "metadata": {
1273 "additionalProperties": { 1443 "additionalProperties": {
1274 "description": "Properties of the object. Contains field @type with type URL.", 1444 "description": "Properties of the object. Contains field @type with type URL.",
1275 "type": "any" 1445 "type": "any"
1276 }, 1446 },
1277 "description": "Service-specific metadata. For example the a vailable capacity at the given\nlocation.", 1447 "description": "Service-specific metadata. For example the a vailable capacity at the given\nlocation.",
1278 "type": "object" 1448 "type": "object"
1449 },
1450 "labels": {
1451 "additionalProperties": {
1452 "type": "string"
1453 },
1454 "description": "Cross-service attributes for the location. F or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
1455 "type": "object"
1456 },
1457 "name": {
1458 "description": "Resource name for the location, which may va ry between implementations.\nFor example: `\"projects/example-project/locations/ us-east1\"`",
1459 "type": "string"
1279 } 1460 }
1280 }, 1461 },
1281 "type": "object" 1462 "type": "object"
1282 }, 1463 },
1283 "TransferConfig": { 1464 "TransferConfig": {
1284 "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.", 1465 "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.",
1285 "id": "TransferConfig", 1466 "id": "TransferConfig",
1286 "properties": { 1467 "properties": {
1287 "datasetRegion": { 1468 "datasetRegion": {
1288 "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly", 1469 "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\nOutput only.",
1289 "type": "string" 1470 "type": "string"
1290 }, 1471 },
1291 "displayName": { 1472 "displayName": {
1292 "description": "User specified display name for the data tra nsfer.", 1473 "description": "User specified display name for the data tra nsfer.",
1293 "type": "string" 1474 "type": "string"
1294 }, 1475 },
1295 "nextRunTime": {
1296 "description": "Next time when data transfer will run. Outpu t only. Applicable\nonly for batch data transfers.\n@OutputOnly",
1297 "format": "google-datetime",
1298 "type": "string"
1299 },
1300 "disabled": { 1476 "disabled": {
1301 "description": "Is this config disabled. When set to true, n o runs are scheduled\nfor a given transfer.", 1477 "description": "Is this config disabled. When set to true, n o runs are scheduled\nfor a given transfer.",
1302 "type": "boolean" 1478 "type": "boolean"
1303 }, 1479 },
1304 "updateTime": { 1480 "nextRunTime": {
1305 "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly", 1481 "description": "Next time when data transfer will run.\nOutp ut only.",
1306 "format": "google-datetime", 1482 "format": "google-datetime",
1307 "type": "string" 1483 "type": "string"
1308 }, 1484 },
1485 "updateTime": {
1486 "description": "Data transfer modification time. Ignored by server on input.\nOutput only.",
1487 "format": "google-datetime",
1488 "type": "string"
1489 },
1309 "schedule": { 1490 "schedule": {
1310 "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the d efault value for the data source will be\nused.\nThe specified times are in UTC. \nExamples of valid format:\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`.\nSee more explanation abo ut the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/sch eduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.", 1491 "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the d efault value for the data source will be\nused.\nThe specified times are in UTC. \nExamples of valid format:\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`.\nSee more explanation abo ut the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/sch eduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
1311 "type": "string" 1492 "type": "string"
1312 }, 1493 },
1313 "dataRefreshWindowDays": { 1494 "dataRefreshWindowDays": {
1314 "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.", 1495 "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.",
1315 "format": "int32", 1496 "format": "int32",
1316 "type": "integer" 1497 "type": "integer"
1317 }, 1498 },
1318 "dataSourceId": { 1499 "dataSourceId": {
1319 "description": "Data source id. Cannot be changed once data transfer is created.", 1500 "description": "Data source id. Cannot be changed once data transfer is created.",
1320 "type": "string" 1501 "type": "string"
1321 }, 1502 },
1322 "status": { 1503 "state": {
1323 "description": "Status of the most recently updated transfer run.\n@OutputOnly", 1504 "description": "State of the most recently updated transfer run.\nOutput only.",
1324 "enum": [ 1505 "enum": [
1325 "TRANSFER_STATUS_UNSPECIFIED", 1506 "TRANSFER_STATE_UNSPECIFIED",
1326 "INACTIVE", 1507 "INACTIVE",
1327 "PENDING", 1508 "PENDING",
1328 "RUNNING", 1509 "RUNNING",
1329 "SUCCEEDED", 1510 "SUCCEEDED",
1330 "FAILED", 1511 "FAILED",
1331 "CANCELLED" 1512 "CANCELLED"
1332 ], 1513 ],
1333 "enumDescriptions": [ 1514 "enumDescriptions": [
1334 "Status placeholder.", 1515 "State placeholder.",
1335 "Data transfer is inactive.", 1516 "Data transfer is inactive.",
1336 "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.", 1517 "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
1337 "Data transfer is in progress.", 1518 "Data transfer is in progress.",
1338 "Data transfer completed successsfully.", 1519 "Data transfer completed successsfully.",
1339 "Data transfer failed.", 1520 "Data transfer failed.",
1340 "Data transfer is cancelled." 1521 "Data transfer is cancelled."
1341 ], 1522 ],
1342 "type": "string" 1523 "type": "string"
1343 }, 1524 },
1525 "destinationDatasetId": {
1526 "description": "The BigQuery target dataset id.",
1527 "type": "string"
1528 },
1344 "name": { 1529 "name": {
1345 "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.", 1530 "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.",
1346 "type": "string" 1531 "type": "string"
1347 }, 1532 },
1348 "destinationDatasetId": {
1349 "description": "The BigQuery target dataset id.",
1350 "type": "string"
1351 },
1352 "userId": { 1533 "userId": {
1353 "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", 1534 "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.\nOutput on ly.",
1354 "format": "int64", 1535 "format": "int64",
1355 "type": "string" 1536 "type": "string"
1356 }, 1537 },
1357 "params": { 1538 "params": {
1358 "additionalProperties": { 1539 "additionalProperties": {
1359 "description": "Properties of the object.", 1540 "description": "Properties of the object.",
1360 "type": "any" 1541 "type": "any"
1361 }, 1542 },
1362 "description": "Data transfer specific parameters.", 1543 "description": "Data transfer specific parameters.",
1363 "type": "object" 1544 "type": "object"
1364 } 1545 }
1365 }, 1546 },
1366 "type": "object" 1547 "type": "object"
1367 }, 1548 },
1368 "TransferRun": { 1549 "TransferRun": {
1369 "description": "Represents a data transfer run.", 1550 "description": "Represents a data transfer run.",
1370 "id": "TransferRun", 1551 "id": "TransferRun",
1371 "properties": { 1552 "properties": {
1553 "destinationDatasetId": {
1554 "description": "The BigQuery target dataset id.",
1555 "type": "string"
1556 },
1557 "name": {
1558 "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.",
1559 "type": "string"
1560 },
1561 "userId": {
1562 "description": "The user id for this transfer run.\nOutput o nly.",
1563 "format": "int64",
1564 "type": "string"
1565 },
1566 "params": {
1567 "additionalProperties": {
1568 "description": "Properties of the object.",
1569 "type": "any"
1570 },
1571 "description": "Data transfer specific parameters.",
1572 "type": "object"
1573 },
1574 "endTime": {
1575 "description": "Time when transfer run ended. Parameter igno red by server for input\nrequests.\nOutput only.",
1576 "format": "google-datetime",
1577 "type": "string"
1578 },
1579 "datasetRegion": {
1580 "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\nOutput only.",
1581 "type": "string"
1582 },
1583 "startTime": {
1584 "description": "Time when transfer run was started. Paramete r ignored by server for input\nrequests.\nOutput only.",
1585 "format": "google-datetime",
1586 "type": "string"
1587 },
1372 "scheduleTime": { 1588 "scheduleTime": {
1373 "description": "Minimum time after which a transfer run can be started.", 1589 "description": "Minimum time after which a transfer run can be started.",
1374 "format": "google-datetime", 1590 "format": "google-datetime",
1375 "type": "string" 1591 "type": "string"
1376 }, 1592 },
1593 "schedule": {
1594 "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.\nOutput only.",
1595 "type": "string"
1596 },
1377 "updateTime": { 1597 "updateTime": {
1378 "description": "Last time the data transfer run status was u pdated.\n@OutputOnly", 1598 "description": "Last time the data transfer run state was up dated.\nOutput only.",
1379 "format": "google-datetime", 1599 "format": "google-datetime",
1380 "type": "string" 1600 "type": "string"
1381 }, 1601 },
1382 "schedule": {
1383 "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",
1384 "type": "string"
1385 },
1386 "runTime": { 1602 "runTime": {
1387 "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.", 1603 "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
1388 "format": "google-datetime", 1604 "format": "google-datetime",
1389 "type": "string" 1605 "type": "string"
1390 }, 1606 },
1391 "dataSourceId": { 1607 "dataSourceId": {
1392 "description": "Data source id.\n@OutputOnly", 1608 "description": "Data source id.\nOutput only.",
1393 "type": "string" 1609 "type": "string"
1394 }, 1610 },
1395 "status": { 1611 "state": {
1396 "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly", 1612 "description": "Data transfer run state. Ignored for input r equests.\nOutput only.",
1397 "enum": [ 1613 "enum": [
1398 "TRANSFER_STATUS_UNSPECIFIED", 1614 "TRANSFER_STATE_UNSPECIFIED",
1399 "INACTIVE", 1615 "INACTIVE",
1400 "PENDING", 1616 "PENDING",
1401 "RUNNING", 1617 "RUNNING",
1402 "SUCCEEDED", 1618 "SUCCEEDED",
1403 "FAILED", 1619 "FAILED",
1404 "CANCELLED" 1620 "CANCELLED"
1405 ], 1621 ],
1406 "enumDescriptions": [ 1622 "enumDescriptions": [
1407 "Status placeholder.", 1623 "State placeholder.",
1408 "Data transfer is inactive.", 1624 "Data transfer is inactive.",
1409 "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.", 1625 "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
1410 "Data transfer is in progress.", 1626 "Data transfer is in progress.",
1411 "Data transfer completed successsfully.", 1627 "Data transfer completed successsfully.",
1412 "Data transfer failed.", 1628 "Data transfer failed.",
1413 "Data transfer is cancelled." 1629 "Data transfer is cancelled."
1414 ], 1630 ],
1415 "type": "string" 1631 "type": "string"
1416 },
1417 "name": {
1418 "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.",
1419 "type": "string"
1420 },
1421 "userId": {
1422 "description": "The user id for this transfer run.\n@OutputO nly",
1423 "format": "int64",
1424 "type": "string"
1425 },
1426 "destinationDatasetId": {
1427 "description": "The BigQuery target dataset id.",
1428 "type": "string"
1429 },
1430 "params": {
1431 "additionalProperties": {
1432 "description": "Properties of the object.",
1433 "type": "any"
1434 },
1435 "description": "Data transfer specific parameters.",
1436 "type": "object"
1437 },
1438 "endTime": {
1439 "description": "Time when transfer run ended. Parameter igno red by server for input\nrequests.\n@OutputOnly",
1440 "format": "google-datetime",
1441 "type": "string"
1442 },
1443 "startTime": {
1444 "description": "Time when transfer run was started. Paramete r ignored by server for input\nrequests.\n@OutputOnly",
1445 "format": "google-datetime",
1446 "type": "string"
1447 },
1448 "datasetRegion": {
1449 "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
1450 "type": "string"
1451 } 1632 }
1452 }, 1633 },
1453 "type": "object" 1634 "type": "object"
1454 }, 1635 },
1455 "CheckValidCredsRequest": { 1636 "CheckValidCredsRequest": {
1456 "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.", 1637 "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.",
1457 "id": "CheckValidCredsRequest", 1638 "id": "CheckValidCredsRequest",
1458 "properties": {}, 1639 "properties": {},
1459 "type": "object" 1640 "type": "object"
1460 }, 1641 },
(...skipping 15 matching lines...) Expand all
1476 "createdRuns": { 1657 "createdRuns": {
1477 "description": "The transfer runs that were created.", 1658 "description": "The transfer runs that were created.",
1478 "items": { 1659 "items": {
1479 "$ref": "TransferRun" 1660 "$ref": "TransferRun"
1480 }, 1661 },
1481 "type": "array" 1662 "type": "array"
1482 } 1663 }
1483 }, 1664 },
1484 "type": "object" 1665 "type": "object"
1485 }, 1666 },
1667 "ListTransferLogsResponse": {
1668 "description": "The returned list transfer run messages.",
1669 "id": "ListTransferLogsResponse",
1670 "properties": {
1671 "nextPageToken": {
1672 "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.\nOutput only.",
1673 "type": "string"
1674 },
1675 "transferMessages": {
1676 "description": "The stored pipeline transfer messages.\nOutp ut only.",
1677 "items": {
1678 "$ref": "TransferMessage"
1679 },
1680 "type": "array"
1681 }
1682 },
1683 "type": "object"
1684 },
1486 "TransferMessage": { 1685 "TransferMessage": {
1487 "description": "Represents a user facing message for a particular da ta transfer run.", 1686 "description": "Represents a user facing message for a particular da ta transfer run.",
1488 "id": "TransferMessage", 1687 "id": "TransferMessage",
1489 "properties": { 1688 "properties": {
1490 "messageText": { 1689 "messageText": {
1491 "description": "Message text.", 1690 "description": "Message text.",
1492 "type": "string" 1691 "type": "string"
1493 }, 1692 },
1494 "severity": { 1693 "severity": {
1495 "description": "Message severity.", 1694 "description": "Message severity.",
(...skipping 12 matching lines...) Expand all
1508 "type": "string" 1707 "type": "string"
1509 }, 1708 },
1510 "messageTime": { 1709 "messageTime": {
1511 "description": "Time when message was logged.", 1710 "description": "Time when message was logged.",
1512 "format": "google-datetime", 1711 "format": "google-datetime",
1513 "type": "string" 1712 "type": "string"
1514 } 1713 }
1515 }, 1714 },
1516 "type": "object" 1715 "type": "object"
1517 }, 1716 },
1518 "ListTransferLogsResponse": {
1519 "description": "The returned list transfer run messages.",
1520 "id": "ListTransferLogsResponse",
1521 "properties": {
1522 "transferMessages": {
1523 "description": "The stored pipeline transfer messages.\n@Out putOnly",
1524 "items": {
1525 "$ref": "TransferMessage"
1526 },
1527 "type": "array"
1528 },
1529 "nextPageToken": {
1530 "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",
1531 "type": "string"
1532 }
1533 },
1534 "type": "object"
1535 },
1536 "ListDataSourcesResponse": { 1717 "ListDataSourcesResponse": {
1537 "description": "Returns list of supported data sources and their met adata.", 1718 "description": "Returns list of supported data sources and their met adata.",
1538 "id": "ListDataSourcesResponse", 1719 "id": "ListDataSourcesResponse",
1539 "properties": { 1720 "properties": {
1540 "nextPageToken": { 1721 "nextPageToken": {
1541 "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", 1722 "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",
1542 "type": "string" 1723 "type": "string"
1543 }, 1724 },
1544 "dataSources": { 1725 "dataSources": {
1545 "description": "List of supported data sources and their tra nsfer settings.", 1726 "description": "List of supported data sources and their tra nsfer settings.",
1546 "items": { 1727 "items": {
1547 "$ref": "DataSource" 1728 "$ref": "DataSource"
1548 }, 1729 },
1549 "type": "array" 1730 "type": "array"
1550 } 1731 }
1551 }, 1732 },
1552 "type": "object" 1733 "type": "object"
1553 }, 1734 },
1554 "DataSourceParameter": { 1735 "DataSourceParameter": {
1555 "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.", 1736 "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.",
1556 "id": "DataSourceParameter", 1737 "id": "DataSourceParameter",
1557 "properties": { 1738 "properties": {
1739 "fields": {
1740 "description": "When parameter is a record, describes child fields.",
1741 "items": {
1742 "$ref": "DataSourceParameter"
1743 },
1744 "type": "array"
1745 },
1746 "maxValue": {
1747 "description": "For integer and double values specifies maxm inum allowed value.",
1748 "format": "double",
1749 "type": "number"
1750 },
1751 "type": {
1752 "description": "Parameter type.",
1753 "enum": [
1754 "TYPE_UNSPECIFIED",
1755 "STRING",
1756 "INTEGER",
1757 "DOUBLE",
1758 "BOOLEAN",
1759 "RECORD",
1760 "PLUS_PAGE"
1761 ],
1762 "enumDescriptions": [
1763 "Type unspecified.",
1764 "String parameter.",
1765 "Integer parameter (64-bits).\nWill be serialized to jso n as string.",
1766 "Double precision floating point parameter.",
1767 "Boolean parameter.",
1768 "Record parameter.",
1769 "Page ID for a Google+ Page."
1770 ],
1771 "type": "string"
1772 },
1558 "recurse": { 1773 "recurse": {
1559 "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.", 1774 "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.",
1560 "type": "boolean" 1775 "type": "boolean"
1561 }, 1776 },
1562 "description": { 1777 "description": {
1563 "description": "Parameter description.", 1778 "description": "Parameter description.",
1564 "type": "string" 1779 "type": "string"
1565 }, 1780 },
1566 "allowedValues": { 1781 "allowedValues": {
1567 "description": "All possible values for the parameter.", 1782 "description": "All possible values for the parameter.",
1568 "items": { 1783 "items": {
1569 "type": "string" 1784 "type": "string"
1570 }, 1785 },
1571 "type": "array" 1786 "type": "array"
1572 }, 1787 },
1573 "validationHelpUrl": {
1574 "description": "URL to a help document to further explain th e naming requirements.",
1575 "type": "string"
1576 },
1577 "minValue": { 1788 "minValue": {
1578 "description": "For integer and double values specifies mini mum allowed value.", 1789 "description": "For integer and double values specifies mini mum allowed value.",
1579 "format": "double", 1790 "format": "double",
1580 "type": "number" 1791 "type": "number"
1581 }, 1792 },
1793 "validationHelpUrl": {
1794 "description": "URL to a help document to further explain th e naming requirements.",
1795 "type": "string"
1796 },
1582 "validationRegex": { 1797 "validationRegex": {
1583 "description": "Regular expression which can be used for par ameter validation.", 1798 "description": "Regular expression which can be used for par ameter validation.",
1584 "type": "string" 1799 "type": "string"
1585 }, 1800 },
1586 "paramId": { 1801 "paramId": {
1587 "description": "Parameter identifier.", 1802 "description": "Parameter identifier.",
1588 "type": "string" 1803 "type": "string"
1589 }, 1804 },
1590 "required": { 1805 "required": {
1591 "description": "Is parameter required.", 1806 "description": "Is parameter required.",
1592 "type": "boolean" 1807 "type": "boolean"
1593 }, 1808 },
1594 "repeated": { 1809 "repeated": {
1595 "description": "Can parameter have multiple values.", 1810 "description": "Can parameter have multiple values.",
1596 "type": "boolean" 1811 "type": "boolean"
1597 }, 1812 },
1598 "displayName": { 1813 "displayName": {
1599 "description": "Parameter display name in the user interface .", 1814 "description": "Parameter display name in the user interface .",
1600 "type": "string" 1815 "type": "string"
1601 }, 1816 },
1817 "validationDescription": {
1818 "description": "Description of the requirements for this fie ld, in case the user input does\nnot fulfill the regex pattern or min/max values .",
1819 "type": "string"
1820 },
1602 "immutable": { 1821 "immutable": {
1603 "description": "Cannot be changed after initial creation.", 1822 "description": "Cannot be changed after initial creation.",
1604 "type": "boolean" 1823 "type": "boolean"
1605 },
1606 "validationDescription": {
1607 "description": "Description of the requirements for this fie ld, in case the user input does\nnot fulfill the regex pattern or min/max values .",
1608 "type": "string"
1609 },
1610 "fields": {
1611 "description": "When parameter is a record, describes child fields.",
1612 "items": {
1613 "$ref": "DataSourceParameter"
1614 },
1615 "type": "array"
1616 },
1617 "maxValue": {
1618 "description": "For integer and double values specifies maxm inum allowed value.",
1619 "format": "double",
1620 "type": "number"
1621 },
1622 "type": {
1623 "description": "Parameter type.",
1624 "enum": [
1625 "TYPE_UNSPECIFIED",
1626 "STRING",
1627 "INTEGER",
1628 "DOUBLE",
1629 "BOOLEAN",
1630 "RECORD",
1631 "PLUS_PAGE"
1632 ],
1633 "enumDescriptions": [
1634 "Type unspecified.",
1635 "String parameter.",
1636 "Integer parameter (64-bits).\nWill be serialized to jso n as string.",
1637 "Double precision floating point parameter.",
1638 "Boolean parameter.",
1639 "Record parameter.",
1640 "Page ID for a Google+ Page."
1641 ],
1642 "type": "string"
1643 } 1824 }
1644 }, 1825 },
1645 "type": "object" 1826 "type": "object"
1646 },
1647 "ListTransferRunsResponse": {
1648 "description": "The returned list of pipelines in the project.",
1649 "id": "ListTransferRunsResponse",
1650 "properties": {
1651 "transferRuns": {
1652 "description": "The stored pipeline transfer runs.\n@OutputO nly",
1653 "items": {
1654 "$ref": "TransferRun"
1655 },
1656 "type": "array"
1657 },
1658 "nextPageToken": {
1659 "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",
1660 "type": "string"
1661 }
1662 },
1663 "type": "object"
1664 }, 1827 },
1665 "ListLocationsResponse": { 1828 "ListLocationsResponse": {
1666 "description": "The response message for Locations.ListLocations.", 1829 "description": "The response message for Locations.ListLocations.",
1667 "id": "ListLocationsResponse", 1830 "id": "ListLocationsResponse",
1668 "properties": { 1831 "properties": {
1832 "nextPageToken": {
1833 "description": "The standard List next-page token.",
1834 "type": "string"
1835 },
1669 "locations": { 1836 "locations": {
1670 "description": "A list of locations that matches the specifi ed filter in the request.", 1837 "description": "A list of locations that matches the specifi ed filter in the request.",
1671 "items": { 1838 "items": {
1672 "$ref": "Location" 1839 "$ref": "Location"
1673 }, 1840 },
1674 "type": "array" 1841 "type": "array"
1842 }
1843 },
1844 "type": "object"
1845 },
1846 "ListTransferRunsResponse": {
1847 "description": "The returned list of pipelines in the project.",
1848 "id": "ListTransferRunsResponse",
1849 "properties": {
1850 "nextPageToken": {
1851 "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.\nOutput only.",
1852 "type": "string"
1675 }, 1853 },
1676 "nextPageToken": { 1854 "transferRuns": {
1677 "description": "The standard List next-page token.", 1855 "description": "The stored pipeline transfer runs.\nOutput o nly.",
1678 "type": "string" 1856 "items": {
1857 "$ref": "TransferRun"
1858 },
1859 "type": "array"
1679 } 1860 }
1680 }, 1861 },
1681 "type": "object" 1862 "type": "object"
1682 }, 1863 },
1683 "IsEnabledRequest": { 1864 "IsEnabledRequest": {
1684 "description": "A request to determine whether data transfer is enab led for the project.", 1865 "description": "A request to determine whether data transfer is enab led for the project.",
1685 "id": "IsEnabledRequest", 1866 "id": "IsEnabledRequest",
1686 "properties": {}, 1867 "properties": {},
1687 "type": "object" 1868 "type": "object"
1688 },
1689 "SetEnabledRequest": {
1690 "description": "A request to set whether data transfer is enabled or disabled for a project.",
1691 "id": "SetEnabledRequest",
1692 "properties": {
1693 "enabled": {
1694 "description": "Whether data transfer should be enabled or d isabled for the project.",
1695 "type": "boolean"
1696 }
1697 },
1698 "type": "object"
1699 },
1700 "ListTransferConfigsResponse": {
1701 "description": "The returned list of pipelines in the project.",
1702 "id": "ListTransferConfigsResponse",
1703 "properties": {
1704 "transferConfigs": {
1705 "description": "The stored pipeline transfer configurations. \n@OutputOnly",
1706 "items": {
1707 "$ref": "TransferConfig"
1708 },
1709 "type": "array"
1710 },
1711 "nextPageToken": {
1712 "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",
1713 "type": "string"
1714 }
1715 },
1716 "type": "object"
1717 },
1718 "IsEnabledResponse": {
1719 "description": "A response to indicate whether data transfer is enab led for the project.",
1720 "id": "IsEnabledResponse",
1721 "properties": {
1722 "enabled": {
1723 "description": "Indicates whether the project is enabled.",
1724 "type": "boolean"
1725 }
1726 },
1727 "type": "object"
1728 },
1729 "DataSource": {
1730 "description": "Represents data source metadata. Metadata is suffici ent to\nrender UI and request proper OAuth tokens.",
1731 "id": "DataSource",
1732 "properties": {
1733 "name": {
1734 "description": "Data source resource name.",
1735 "type": "string"
1736 },
1737 "scopes": {
1738 "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",
1739 "items": {
1740 "type": "string"
1741 },
1742 "type": "array"
1743 },
1744 "clientId": {
1745 "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.",
1746 "type": "string"
1747 },
1748 "authorizationType": {
1749 "description": "Indicates the type of authorization.",
1750 "enum": [
1751 "AUTHORIZATION_TYPE_UNSPECIFIED",
1752 "AUTHORIZATION_CODE",
1753 "GOOGLE_PLUS_AUTHORIZATION_CODE"
1754 ],
1755 "enumDescriptions": [
1756 "Type unspecified.",
1757 "Use OAuth 2 authorization codes that can be exchanged\n for a refresh token on the backend.",
1758 "Return an authorization code for a given Google+ page t hat can then be\nexchanged for a refresh token on the backend."
1759 ],
1760 "type": "string"
1761 },
1762 "supportsCustomSchedule": {
1763 "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.",
1764 "type": "boolean"
1765 },
1766 "displayName": {
1767 "description": "User friendly data source name.",
1768 "type": "string"
1769 },
1770 "dataRefreshType": {
1771 "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.",
1772 "enum": [
1773 "NONE",
1774 "SLIDING_WINDOW",
1775 "CUSTOM_SLIDING_WINDOW"
1776 ],
1777 "enumDescriptions": [
1778 "The data source won't support data auto refresh, which is default value.",
1779 "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.",
1780 "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."
1781 ],
1782 "type": "string"
1783 },
1784 "parameters": {
1785 "description": "Data source parameters.",
1786 "items": {
1787 "$ref": "DataSourceParameter"
1788 },
1789 "type": "array"
1790 },
1791 "helpUrl": {
1792 "description": "Url for the help document for this data sour ce.",
1793 "type": "string"
1794 },
1795 "defaultSchedule": {
1796 "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`.",
1797 "type": "string"
1798 },
1799 "statusUpdateDeadlineSeconds": {
1800 "description": "The number of seconds to wait for a status u pdate from the data source\nbefore BigQuery marks the transfer as failed.",
1801 "format": "int32",
1802 "type": "integer"
1803 },
1804 "supportsMultipleTransfers": {
1805 "description": "Indicates whether the data source supports m ultiple transfers\nto different BigQuery targets.",
1806 "type": "boolean"
1807 },
1808 "manualRunsDisabled": {
1809 "description": "Disables backfilling and manual run scheduli ng\nfor the data source.",
1810 "type": "boolean"
1811 },
1812 "defaultDataRefreshWindowDays": {
1813 "description": "Default data refresh window on days.\nOnly m eaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
1814 "format": "int32",
1815 "type": "integer"
1816 },
1817 "transferType": {
1818 "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.",
1819 "enum": [
1820 "TRANSFER_TYPE_UNSPECIFIED",
1821 "BATCH",
1822 "STREAMING"
1823 ],
1824 "enumDescriptions": [
1825 "Invalid or Unknown transfer type placeholder.",
1826 "Batch data transfer.",
1827 "Streaming data transfer. Streaming data source currentl y doesn't\nsupport multiple transfer configs per project."
1828 ],
1829 "type": "string"
1830 },
1831 "description": {
1832 "description": "User friendly data source description string .",
1833 "type": "string"
1834 },
1835 "dataSourceId": {
1836 "description": "Data source id.",
1837 "type": "string"
1838 }
1839 },
1840 "type": "object"
1841 },
1842 "ScheduleTransferRunsRequest": {
1843 "description": "A request to schedule transfer runs for a time range .",
1844 "id": "ScheduleTransferRunsRequest",
1845 "properties": {
1846 "rangeEndTime": {
1847 "description": "End time of the range of transfer runs.",
1848 "format": "google-datetime",
1849 "type": "string"
1850 },
1851 "rangeStartTime": {
1852 "description": "Start time of the range of transfer runs.",
1853 "format": "google-datetime",
1854 "type": "string"
1855 }
1856 },
1857 "type": "object"
1858 },
1859 "Empty": {
1860 "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 `{}`.",
1861 "id": "Empty",
1862 "properties": {},
1863 "type": "object"
1864 } 1869 }
1865 }, 1870 },
1866 "servicePath": "", 1871 "servicePath": "",
1867 "title": "BigQuery Data Transfer Service API", 1872 "title": "BigQuery Data Transfer Service API",
1868 "version": "v1" 1873 "version": "v1"
1869 } 1874 }
OLDNEW
« no previous file with comments | « discovery/googleapis/bigquery__v2.json ('k') | discovery/googleapis/blogger__v3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698