OLD | NEW |
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 }, |
| 8 "https://www.googleapis.com/auth/cloud-platform.read-only": { |
| 9 "description": "View your data across Google Cloud Platform
services" |
| 10 }, |
| 11 "https://www.googleapis.com/auth/cloud-platform": { |
| 12 "description": "View and manage your data across Google Clou
d Platform services" |
7 } | 13 } |
8 } | 14 } |
9 } | 15 } |
10 }, | 16 }, |
11 "basePath": "", | 17 "basePath": "", |
12 "baseUrl": "https://bigquerydatatransfer.googleapis.com/", | 18 "baseUrl": "https://bigquerydatatransfer.googleapis.com/", |
13 "batchPath": "batch", | 19 "batchPath": "batch", |
14 "canonicalName": "BigQuery Data Transfer", | 20 "canonicalName": "BigQuery Data Transfer", |
15 "description": "Transfers data from partner SaaS applications to Google BigQ
uery on a scheduled, managed basis.", | 21 "description": "Transfers data from partner SaaS applications to Google BigQ
uery on a scheduled, managed basis.", |
16 "discoveryVersion": "v1", | 22 "discoveryVersion": "v1", |
17 "documentationLink": "https://cloud.google.com/bigquery/", | 23 "documentationLink": "https://cloud.google.com/bigquery/", |
18 "icons": { | 24 "icons": { |
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 25 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 26 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
21 }, | 27 }, |
22 "id": "bigquerydatatransfer:v1", | 28 "id": "bigquerydatatransfer:v1", |
23 "kind": "discovery#restDescription", | 29 "kind": "discovery#restDescription", |
24 "name": "bigquerydatatransfer", | 30 "name": "bigquerydatatransfer", |
25 "ownerDomain": "google.com", | 31 "ownerDomain": "google.com", |
26 "ownerName": "Google", | 32 "ownerName": "Google", |
27 "parameters": { | 33 "parameters": { |
| 34 "key": { |
| 35 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 36 "location": "query", |
| 37 "type": "string" |
| 38 }, |
| 39 "access_token": { |
| 40 "description": "OAuth access token.", |
| 41 "location": "query", |
| 42 "type": "string" |
| 43 }, |
| 44 "quotaUser": { |
| 45 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 46 "location": "query", |
| 47 "type": "string" |
| 48 }, |
| 49 "pp": { |
| 50 "default": "true", |
| 51 "description": "Pretty-print response.", |
| 52 "location": "query", |
| 53 "type": "boolean" |
| 54 }, |
| 55 "oauth_token": { |
| 56 "description": "OAuth 2.0 token for the current user.", |
| 57 "location": "query", |
| 58 "type": "string" |
| 59 }, |
| 60 "bearer_token": { |
| 61 "description": "OAuth bearer token.", |
| 62 "location": "query", |
| 63 "type": "string" |
| 64 }, |
28 "upload_protocol": { | 65 "upload_protocol": { |
29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 66 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
30 "location": "query", | 67 "location": "query", |
31 "type": "string" | 68 "type": "string" |
32 }, | 69 }, |
33 "prettyPrint": { | 70 "prettyPrint": { |
34 "default": "true", | 71 "default": "true", |
35 "description": "Returns response with indentations and line breaks."
, | 72 "description": "Returns response with indentations and line breaks."
, |
36 "location": "query", | 73 "location": "query", |
37 "type": "boolean" | 74 "type": "boolean" |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
72 "media", | 109 "media", |
73 "proto" | 110 "proto" |
74 ], | 111 ], |
75 "enumDescriptions": [ | 112 "enumDescriptions": [ |
76 "Responses with Content-Type of application/json", | 113 "Responses with Content-Type of application/json", |
77 "Media download with context-dependent Content-Type", | 114 "Media download with context-dependent Content-Type", |
78 "Responses with Content-Type of application/x-protobuf" | 115 "Responses with Content-Type of application/x-protobuf" |
79 ], | 116 ], |
80 "location": "query", | 117 "location": "query", |
81 "type": "string" | 118 "type": "string" |
82 }, | |
83 "key": { | |
84 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
85 "location": "query", | |
86 "type": "string" | |
87 }, | |
88 "access_token": { | |
89 "description": "OAuth access token.", | |
90 "location": "query", | |
91 "type": "string" | |
92 }, | |
93 "quotaUser": { | |
94 "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.", | |
95 "location": "query", | |
96 "type": "string" | |
97 }, | |
98 "pp": { | |
99 "default": "true", | |
100 "description": "Pretty-print response.", | |
101 "location": "query", | |
102 "type": "boolean" | |
103 }, | |
104 "oauth_token": { | |
105 "description": "OAuth 2.0 token for the current user.", | |
106 "location": "query", | |
107 "type": "string" | |
108 }, | |
109 "bearer_token": { | |
110 "description": "OAuth bearer token.", | |
111 "location": "query", | |
112 "type": "string" | |
113 } | 119 } |
114 }, | 120 }, |
115 "protocol": "rest", | 121 "protocol": "rest", |
116 "resources": { | 122 "resources": { |
117 "projects": { | 123 "projects": { |
118 "methods": { | 124 "methods": { |
119 "isEnabled": { | 125 "setEnabled": { |
120 "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.", |
121 "httpMethod": "POST", | 127 "httpMethod": "POST", |
122 "id": "bigquerydatatransfer.projects.isEnabled", | 128 "id": "bigquerydatatransfer.projects.setEnabled", |
123 "parameterOrder": [ | 129 "parameterOrder": [ |
124 "name" | 130 "name" |
125 ], | 131 ], |
126 "parameters": { | 132 "parameters": { |
127 "name": { | 133 "name": { |
128 "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}`", |
129 "location": "path", | 135 "location": "path", |
130 "pattern": "^projects/[^/]+$", | 136 "pattern": "^projects/[^/]+$", |
131 "required": true, | 137 "required": true, |
132 "type": "string" | 138 "type": "string" |
133 } | 139 } |
134 }, | 140 }, |
135 "path": "v1/{+name}:isEnabled", | 141 "path": "v1/{+name}:setEnabled", |
136 "request": { | 142 "request": { |
137 "$ref": "IsEnabledRequest" | 143 "$ref": "SetEnabledRequest" |
138 }, | 144 }, |
139 "response": { | 145 "response": { |
140 "$ref": "IsEnabledResponse" | 146 "$ref": "Empty" |
141 }, | 147 }, |
142 "scopes": [ | 148 "scopes": [ |
143 "https://www.googleapis.com/auth/bigquery" | 149 "https://www.googleapis.com/auth/cloud-platform" |
144 ] | 150 ] |
145 }, | 151 }, |
146 "setEnabled": { | 152 "isEnabled": { |
147 "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.", |
148 "httpMethod": "POST", | 154 "httpMethod": "POST", |
149 "id": "bigquerydatatransfer.projects.setEnabled", | 155 "id": "bigquerydatatransfer.projects.isEnabled", |
150 "parameterOrder": [ | 156 "parameterOrder": [ |
151 "name" | 157 "name" |
152 ], | 158 ], |
153 "parameters": { | 159 "parameters": { |
154 "name": { | 160 "name": { |
155 "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}`", |
156 "location": "path", | 162 "location": "path", |
157 "pattern": "^projects/[^/]+$", | 163 "pattern": "^projects/[^/]+$", |
158 "required": true, | 164 "required": true, |
159 "type": "string" | 165 "type": "string" |
160 } | 166 } |
161 }, | 167 }, |
162 "path": "v1/{+name}:setEnabled", | 168 "path": "v1/{+name}:isEnabled", |
163 "request": { | 169 "request": { |
164 "$ref": "SetEnabledRequest" | 170 "$ref": "IsEnabledRequest" |
165 }, | 171 }, |
166 "response": { | 172 "response": { |
167 "$ref": "Empty" | 173 "$ref": "IsEnabledResponse" |
168 } | 174 }, |
| 175 "scopes": [ |
| 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 ] |
169 } | 180 } |
170 }, | 181 }, |
171 "resources": { | 182 "resources": { |
172 "locations": { | 183 "locations": { |
173 "methods": { | 184 "methods": { |
174 "isEnabled": { | 185 "isEnabled": { |
175 "description": "Returns true if data transfer is ena
bled for a project.", | 186 "description": "Returns true if data transfer is ena
bled for a project.", |
176 "httpMethod": "POST", | 187 "httpMethod": "POST", |
177 "id": "bigquerydatatransfer.projects.locations.isEna
bled", | 188 "id": "bigquerydatatransfer.projects.locations.isEna
bled", |
178 "parameterOrder": [ | 189 "parameterOrder": [ |
179 "name" | 190 "name" |
180 ], | 191 ], |
181 "parameters": { | 192 "parameters": { |
182 "name": { | 193 "name": { |
183 "description": "The name of the project reso
urce in the form:\n`projects/{project_id}`", | 194 "description": "The name of the project reso
urce in the form:\n`projects/{project_id}`", |
184 "location": "path", | 195 "location": "path", |
185 "pattern": "^projects/[^/]+/locations/[^/]+$
", | 196 "pattern": "^projects/[^/]+/locations/[^/]+$
", |
186 "required": true, | 197 "required": true, |
187 "type": "string" | 198 "type": "string" |
188 } | 199 } |
189 }, | 200 }, |
190 "path": "v1/{+name}:isEnabled", | 201 "path": "v1/{+name}:isEnabled", |
191 "request": { | 202 "request": { |
192 "$ref": "IsEnabledRequest" | 203 "$ref": "IsEnabledRequest" |
193 }, | 204 }, |
194 "response": { | 205 "response": { |
195 "$ref": "IsEnabledResponse" | 206 "$ref": "IsEnabledResponse" |
196 }, | 207 }, |
197 "scopes": [ | 208 "scopes": [ |
198 "https://www.googleapis.com/auth/bigquery" | 209 "https://www.googleapis.com/auth/bigquery", |
| 210 "https://www.googleapis.com/auth/cloud-platform"
, |
| 211 "https://www.googleapis.com/auth/cloud-platform.
read-only" |
199 ] | 212 ] |
200 }, | 213 }, |
201 "setEnabled": { | 214 "setEnabled": { |
202 "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.", | 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.", |
203 "httpMethod": "POST", | 216 "httpMethod": "POST", |
204 "id": "bigquerydatatransfer.projects.locations.setEn
abled", | 217 "id": "bigquerydatatransfer.projects.locations.setEn
abled", |
205 "parameterOrder": [ | 218 "parameterOrder": [ |
206 "name" | 219 "name" |
207 ], | 220 ], |
208 "parameters": { | 221 "parameters": { |
209 "name": { | 222 "name": { |
210 "description": "The name of the project reso
urce in the form:\n`projects/{project_id}`", | 223 "description": "The name of the project reso
urce in the form:\n`projects/{project_id}`", |
211 "location": "path", | 224 "location": "path", |
212 "pattern": "^projects/[^/]+/locations/[^/]+$
", | 225 "pattern": "^projects/[^/]+/locations/[^/]+$
", |
213 "required": true, | 226 "required": true, |
214 "type": "string" | 227 "type": "string" |
215 } | 228 } |
216 }, | 229 }, |
217 "path": "v1/{+name}:setEnabled", | 230 "path": "v1/{+name}:setEnabled", |
218 "request": { | 231 "request": { |
219 "$ref": "SetEnabledRequest" | 232 "$ref": "SetEnabledRequest" |
220 }, | 233 }, |
221 "response": { | 234 "response": { |
222 "$ref": "Empty" | 235 "$ref": "Empty" |
223 } | 236 }, |
| 237 "scopes": [ |
| 238 "https://www.googleapis.com/auth/cloud-platform" |
| 239 ] |
224 } | 240 } |
225 }, | 241 }, |
226 "resources": { | 242 "resources": { |
227 "dataSources": { | 243 "transferConfigs": { |
228 "methods": { | 244 "methods": { |
229 "checkValidCreds": { | 245 "get": { |
230 "description": "Returns true if valid creden
tials exist for the given data source and\nrequesting user.", | 246 "description": "Returns information about a
data transfer config.", |
231 "httpMethod": "POST", | 247 "httpMethod": "GET", |
232 "id": "bigquerydatatransfer.projects.locatio
ns.dataSources.checkValidCreds", | 248 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.get", |
233 "parameterOrder": [ | 249 "parameterOrder": [ |
234 "name" | 250 "name" |
235 ], | 251 ], |
236 "parameters": { | 252 "parameters": { |
237 "name": { | 253 "name": { |
238 "description": "The data source in t
he form:\n`projects/{project_id}/dataSources/{data_source_id}`", | 254 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/transfer
Configs/{config_id}`", |
239 "location": "path", | 255 "location": "path", |
240 "pattern": "^projects/[^/]+/location
s/[^/]+/dataSources/[^/]+$", | 256 "pattern": "^projects/[^/]+/location
s/[^/]+/transferConfigs/[^/]+$", |
241 "required": true, | |
242 "type": "string" | |
243 } | |
244 }, | |
245 "path": "v1/{+name}:checkValidCreds", | |
246 "request": { | |
247 "$ref": "CheckValidCredsRequest" | |
248 }, | |
249 "response": { | |
250 "$ref": "CheckValidCredsResponse" | |
251 }, | |
252 "scopes": [ | |
253 "https://www.googleapis.com/auth/bigquer
y" | |
254 ] | |
255 }, | |
256 "get": { | |
257 "description": "Retrieves a supported data s
ource and returns its settings,\nwhich can be used for UI rendering.", | |
258 "httpMethod": "GET", | |
259 "id": "bigquerydatatransfer.projects.locatio
ns.dataSources.get", | |
260 "parameterOrder": [ | |
261 "name" | |
262 ], | |
263 "parameters": { | |
264 "name": { | |
265 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/dataSour
ces/{data_source_id}`", | |
266 "location": "path", | |
267 "pattern": "^projects/[^/]+/location
s/[^/]+/dataSources/[^/]+$", | |
268 "required": true, | 257 "required": true, |
269 "type": "string" | 258 "type": "string" |
270 } | 259 } |
271 }, | 260 }, |
272 "path": "v1/{+name}", | 261 "path": "v1/{+name}", |
273 "response": { | 262 "response": { |
274 "$ref": "DataSource" | 263 "$ref": "TransferConfig" |
275 }, | 264 }, |
276 "scopes": [ | 265 "scopes": [ |
277 "https://www.googleapis.com/auth/bigquer
y" | 266 "https://www.googleapis.com/auth/bigquer
y", |
| 267 "https://www.googleapis.com/auth/cloud-p
latform", |
| 268 "https://www.googleapis.com/auth/cloud-p
latform.read-only" |
| 269 ] |
| 270 }, |
| 271 "patch": { |
| 272 "description": "Updates a data transfer conf
iguration.\nAll fields must be set, even if they are not updated.", |
| 273 "httpMethod": "PATCH", |
| 274 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.patch", |
| 275 "parameterOrder": [ |
| 276 "name" |
| 277 ], |
| 278 "parameters": { |
| 279 "authorizationCode": { |
| 280 "description": "Optional OAuth2 auth
orization code to use with this transfer configuration.\nIf it is provided, the
transfer configuration will be associated with the\ngaia id of the authorizing u
ser.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://
www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclien
tid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id shoul
d be OAuth client_id of BigQuery DTS API for the given\n data source returned b
y ListDataSources method.\n* data_source_scopes are the scopes returned by ListD
ataSources method.\n* redirect_uri is an optional parameter. If not specified, t
hen\n authorization code is posted to the opener of authorization flow window.\
n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf
:wg:oauth:2.0:oob means that authorization code should be\n returned in the tit
le bar of the browser, with the page text prompting\n the user to copy the code
and paste it in the application.", |
| 281 "location": "query", |
| 282 "type": "string" |
| 283 }, |
| 284 "updateMask": { |
| 285 "description": "Required list of fie
lds to be updated in this request.", |
| 286 "format": "google-fieldmask", |
| 287 "location": "query", |
| 288 "type": "string" |
| 289 }, |
| 290 "name": { |
| 291 "description": "The resource name of
the transfer run.\nTransfer run names have the form\n`projects/{project_id}/tra
nsferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it
is not\nguaranteed or required. The name is ignored when creating a transfer run
.", |
| 292 "location": "path", |
| 293 "pattern": "^projects/[^/]+/location
s/[^/]+/transferConfigs/[^/]+$", |
| 294 "required": true, |
| 295 "type": "string" |
| 296 } |
| 297 }, |
| 298 "path": "v1/{+name}", |
| 299 "request": { |
| 300 "$ref": "TransferConfig" |
| 301 }, |
| 302 "response": { |
| 303 "$ref": "TransferConfig" |
| 304 }, |
| 305 "scopes": [ |
| 306 "https://www.googleapis.com/auth/bigquer
y", |
| 307 "https://www.googleapis.com/auth/cloud-p
latform" |
| 308 ] |
| 309 }, |
| 310 "delete": { |
| 311 "description": "Deletes a data transfer conf
iguration,\nincluding any associated transfer runs and logs.", |
| 312 "httpMethod": "DELETE", |
| 313 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.delete", |
| 314 "parameterOrder": [ |
| 315 "name" |
| 316 ], |
| 317 "parameters": { |
| 318 "name": { |
| 319 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/transfer
Configs/{config_id}`", |
| 320 "location": "path", |
| 321 "pattern": "^projects/[^/]+/location
s/[^/]+/transferConfigs/[^/]+$", |
| 322 "required": true, |
| 323 "type": "string" |
| 324 } |
| 325 }, |
| 326 "path": "v1/{+name}", |
| 327 "response": { |
| 328 "$ref": "Empty" |
| 329 }, |
| 330 "scopes": [ |
| 331 "https://www.googleapis.com/auth/bigquer
y", |
| 332 "https://www.googleapis.com/auth/cloud-p
latform" |
278 ] | 333 ] |
279 }, | 334 }, |
280 "list": { | 335 "list": { |
281 "description": "Lists supported data sources
and returns their settings,\nwhich can be used for UI rendering.", | 336 "description": "Returns information about al
l data transfers in the project.", |
282 "httpMethod": "GET", | 337 "httpMethod": "GET", |
283 "id": "bigquerydatatransfer.projects.locatio
ns.dataSources.list", | 338 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.list", |
284 "parameterOrder": [ | 339 "parameterOrder": [ |
285 "parent" | 340 "parent" |
286 ], | 341 ], |
287 "parameters": { | 342 "parameters": { |
| 343 "dataSourceIds": { |
| 344 "description": "When specified, only
configurations of requested data sources are returned.", |
| 345 "location": "query", |
| 346 "repeated": true, |
| 347 "type": "string" |
| 348 }, |
288 "parent": { | 349 "parent": { |
289 "description": "The BigQuery project
id for which data sources should be returned.\nMust be in the form: `projects/{
project_id}`", | 350 "description": "The BigQuery project
id for which data sources\nshould be returned: `projects/{project_id}`.", |
290 "location": "path", | 351 "location": "path", |
291 "pattern": "^projects/[^/]+/location
s/[^/]+$", | 352 "pattern": "^projects/[^/]+/location
s/[^/]+$", |
292 "required": true, | 353 "required": true, |
293 "type": "string" | 354 "type": "string" |
294 }, | 355 }, |
295 "pageToken": { | 356 "pageToken": { |
296 "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.", | 357 "description": "Pagination token, wh
ich can be used to request a specific page\nof `ListTransfersRequest` list resul
ts. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` t
oken, which can be used as the\n`page_token` value to request the next page of l
ist results.", |
297 "location": "query", | 358 "location": "query", |
298 "type": "string" | 359 "type": "string" |
299 }, | 360 }, |
300 "pageSize": { | 361 "pageSize": { |
301 "description": "Page size. The defau
lt page size is the maximum value of 1000 results.", | 362 "description": "Page size. The defau
lt page size is the maximum value of 1000 results.", |
302 "format": "int32", | 363 "format": "int32", |
303 "location": "query", | 364 "location": "query", |
304 "type": "integer" | 365 "type": "integer" |
305 } | 366 } |
306 }, | 367 }, |
307 "path": "v1/{+parent}/dataSources", | 368 "path": "v1/{+parent}/transferConfigs", |
308 "response": { | 369 "response": { |
309 "$ref": "ListDataSourcesResponse" | 370 "$ref": "ListTransferConfigsResponse" |
310 }, | 371 }, |
311 "scopes": [ | 372 "scopes": [ |
312 "https://www.googleapis.com/auth/bigquer
y" | 373 "https://www.googleapis.com/auth/bigquer
y", |
| 374 "https://www.googleapis.com/auth/cloud-p
latform", |
| 375 "https://www.googleapis.com/auth/cloud-p
latform.read-only" |
313 ] | 376 ] |
314 } | 377 }, |
315 } | |
316 }, | |
317 "transferConfigs": { | |
318 "methods": { | |
319 "create": { | 378 "create": { |
320 "description": "Creates a new data transfer
configuration.", | 379 "description": "Creates a new data transfer
configuration.", |
321 "httpMethod": "POST", | 380 "httpMethod": "POST", |
322 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.create", | 381 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.create", |
323 "parameterOrder": [ | 382 "parameterOrder": [ |
324 "parent" | 383 "parent" |
325 ], | 384 ], |
326 "parameters": { | 385 "parameters": { |
327 "authorizationCode": { | 386 "authorizationCode": { |
328 "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.", | 387 "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.", |
329 "location": "query", | 388 "location": "query", |
330 "type": "string" | 389 "type": "string" |
331 }, | 390 }, |
332 "parent": { | 391 "parent": { |
333 "description": "The BigQuery project
id where the transfer configuration should be created.", | 392 "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.", |
334 "location": "path", | 393 "location": "path", |
335 "pattern": "^projects/[^/]+/location
s/[^/]+$", | 394 "pattern": "^projects/[^/]+/location
s/[^/]+$", |
336 "required": true, | 395 "required": true, |
337 "type": "string" | 396 "type": "string" |
338 } | 397 } |
339 }, | 398 }, |
340 "path": "v1/{+parent}/transferConfigs", | 399 "path": "v1/{+parent}/transferConfigs", |
341 "request": { | 400 "request": { |
342 "$ref": "TransferConfig" | 401 "$ref": "TransferConfig" |
343 }, | 402 }, |
344 "response": { | 403 "response": { |
345 "$ref": "TransferConfig" | 404 "$ref": "TransferConfig" |
346 }, | 405 }, |
347 "scopes": [ | 406 "scopes": [ |
348 "https://www.googleapis.com/auth/bigquer
y" | 407 "https://www.googleapis.com/auth/bigquer
y", |
| 408 "https://www.googleapis.com/auth/cloud-p
latform" |
349 ] | 409 ] |
350 }, | 410 }, |
351 "scheduleRuns": { | 411 "scheduleRuns": { |
352 "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.", | 412 "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.", |
353 "httpMethod": "POST", | 413 "httpMethod": "POST", |
354 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.scheduleRuns", | 414 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.scheduleRuns", |
355 "parameterOrder": [ | 415 "parameterOrder": [ |
356 "parent" | 416 "parent" |
357 ], | 417 ], |
358 "parameters": { | 418 "parameters": { |
359 "parent": { | 419 "parent": { |
360 "description": "Transfer configurati
on name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.", | 420 "description": "Transfer configurati
on name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.", |
361 "location": "path", | 421 "location": "path", |
362 "pattern": "^projects/[^/]+/location
s/[^/]+/transferConfigs/[^/]+$", | 422 "pattern": "^projects/[^/]+/location
s/[^/]+/transferConfigs/[^/]+$", |
363 "required": true, | 423 "required": true, |
364 "type": "string" | 424 "type": "string" |
365 } | 425 } |
366 }, | 426 }, |
367 "path": "v1/{+parent}:scheduleRuns", | 427 "path": "v1/{+parent}:scheduleRuns", |
368 "request": { | 428 "request": { |
369 "$ref": "ScheduleTransferRunsRequest" | 429 "$ref": "ScheduleTransferRunsRequest" |
370 }, | 430 }, |
371 "response": { | 431 "response": { |
372 "$ref": "ScheduleTransferRunsResponse" | 432 "$ref": "ScheduleTransferRunsResponse" |
373 }, | 433 }, |
374 "scopes": [ | 434 "scopes": [ |
375 "https://www.googleapis.com/auth/bigquer
y" | 435 "https://www.googleapis.com/auth/bigquer
y", |
376 ] | 436 "https://www.googleapis.com/auth/cloud-p
latform" |
377 }, | |
378 "patch": { | |
379 "description": "Updates a data transfer conf
iguration.\nAll fields must be set, even if they are not updated.", | |
380 "httpMethod": "PATCH", | |
381 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.patch", | |
382 "parameterOrder": [ | |
383 "name" | |
384 ], | |
385 "parameters": { | |
386 "authorizationCode": { | |
387 "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.", | |
388 "location": "query", | |
389 "type": "string" | |
390 }, | |
391 "updateMask": { | |
392 "description": "Required list of fie
lds to be updated in this request.", | |
393 "format": "google-fieldmask", | |
394 "location": "query", | |
395 "type": "string" | |
396 }, | |
397 "name": { | |
398 "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
.", | |
399 "location": "path", | |
400 "pattern": "^projects/[^/]+/location
s/[^/]+/transferConfigs/[^/]+$", | |
401 "required": true, | |
402 "type": "string" | |
403 } | |
404 }, | |
405 "path": "v1/{+name}", | |
406 "request": { | |
407 "$ref": "TransferConfig" | |
408 }, | |
409 "response": { | |
410 "$ref": "TransferConfig" | |
411 }, | |
412 "scopes": [ | |
413 "https://www.googleapis.com/auth/bigquer
y" | |
414 ] | |
415 }, | |
416 "get": { | |
417 "description": "Returns information about a
data transfer config.", | |
418 "httpMethod": "GET", | |
419 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.get", | |
420 "parameterOrder": [ | |
421 "name" | |
422 ], | |
423 "parameters": { | |
424 "name": { | |
425 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/transfer
Configs/{config_id}`", | |
426 "location": "path", | |
427 "pattern": "^projects/[^/]+/location
s/[^/]+/transferConfigs/[^/]+$", | |
428 "required": true, | |
429 "type": "string" | |
430 } | |
431 }, | |
432 "path": "v1/{+name}", | |
433 "response": { | |
434 "$ref": "TransferConfig" | |
435 }, | |
436 "scopes": [ | |
437 "https://www.googleapis.com/auth/bigquer
y" | |
438 ] | |
439 }, | |
440 "delete": { | |
441 "description": "Deletes a data transfer conf
iguration,\nincluding any associated transfer runs and logs.", | |
442 "httpMethod": "DELETE", | |
443 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.delete", | |
444 "parameterOrder": [ | |
445 "name" | |
446 ], | |
447 "parameters": { | |
448 "name": { | |
449 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/transfer
Configs/{config_id}`", | |
450 "location": "path", | |
451 "pattern": "^projects/[^/]+/location
s/[^/]+/transferConfigs/[^/]+$", | |
452 "required": true, | |
453 "type": "string" | |
454 } | |
455 }, | |
456 "path": "v1/{+name}", | |
457 "response": { | |
458 "$ref": "Empty" | |
459 }, | |
460 "scopes": [ | |
461 "https://www.googleapis.com/auth/bigquer
y" | |
462 ] | |
463 }, | |
464 "list": { | |
465 "description": "Returns information about al
l data transfers in the project.", | |
466 "httpMethod": "GET", | |
467 "id": "bigquerydatatransfer.projects.locatio
ns.transferConfigs.list", | |
468 "parameterOrder": [ | |
469 "parent" | |
470 ], | |
471 "parameters": { | |
472 "pageToken": { | |
473 "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.", | |
474 "location": "query", | |
475 "type": "string" | |
476 }, | |
477 "pageSize": { | |
478 "description": "Page size. The defau
lt page size is the maximum value of 1000 results.", | |
479 "format": "int32", | |
480 "location": "query", | |
481 "type": "integer" | |
482 }, | |
483 "parent": { | |
484 "description": "The BigQuery project
id for which data sources\nshould be returned: `projects/{project_id}`.", | |
485 "location": "path", | |
486 "pattern": "^projects/[^/]+/location
s/[^/]+$", | |
487 "required": true, | |
488 "type": "string" | |
489 }, | |
490 "dataSourceIds": { | |
491 "description": "When specified, only
configurations of requested data sources are returned.", | |
492 "location": "query", | |
493 "repeated": true, | |
494 "type": "string" | |
495 } | |
496 }, | |
497 "path": "v1/{+parent}/transferConfigs", | |
498 "response": { | |
499 "$ref": "ListTransferConfigsResponse" | |
500 }, | |
501 "scopes": [ | |
502 "https://www.googleapis.com/auth/bigquer
y" | |
503 ] | 437 ] |
504 } | 438 } |
505 }, | 439 }, |
506 "resources": { | 440 "resources": { |
507 "runs": { | 441 "runs": { |
508 "methods": { | 442 "methods": { |
509 "delete": { | 443 "delete": { |
510 "description": "Deletes the specifie
d transfer run.", | 444 "description": "Deletes the specifie
d transfer run.", |
511 "httpMethod": "DELETE", | 445 "httpMethod": "DELETE", |
512 "id": "bigquerydatatransfer.projects
.locations.transferConfigs.runs.delete", | 446 "id": "bigquerydatatransfer.projects
.locations.transferConfigs.runs.delete", |
513 "parameterOrder": [ | 447 "parameterOrder": [ |
514 "name" | 448 "name" |
515 ], | 449 ], |
516 "parameters": { | 450 "parameters": { |
517 "name": { | 451 "name": { |
518 "description": "The field wi
ll contain name of the resource requested, for example:\n`projects/{project_id}/
transferConfigs/{config_id}/runs/{run_id}`", | 452 "description": "The field wi
ll contain name of the resource requested, for example:\n`projects/{project_id}/
transferConfigs/{config_id}/runs/{run_id}`", |
519 "location": "path", | 453 "location": "path", |
520 "pattern": "^projects/[^/]+/
locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", | 454 "pattern": "^projects/[^/]+/
locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", |
521 "required": true, | 455 "required": true, |
522 "type": "string" | 456 "type": "string" |
523 } | 457 } |
524 }, | 458 }, |
525 "path": "v1/{+name}", | 459 "path": "v1/{+name}", |
526 "response": { | 460 "response": { |
527 "$ref": "Empty" | 461 "$ref": "Empty" |
528 }, | 462 }, |
529 "scopes": [ | 463 "scopes": [ |
530 "https://www.googleapis.com/auth
/bigquery" | 464 "https://www.googleapis.com/auth
/bigquery", |
531 ] | 465 "https://www.googleapis.com/auth
/cloud-platform" |
532 }, | |
533 "get": { | |
534 "description": "Returns information
about the particular transfer run.", | |
535 "httpMethod": "GET", | |
536 "id": "bigquerydatatransfer.projects
.locations.transferConfigs.runs.get", | |
537 "parameterOrder": [ | |
538 "name" | |
539 ], | |
540 "parameters": { | |
541 "name": { | |
542 "description": "The field wi
ll contain name of the resource requested, for example:\n`projects/{project_id}/
transferConfigs/{config_id}/runs/{run_id}`", | |
543 "location": "path", | |
544 "pattern": "^projects/[^/]+/
locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", | |
545 "required": true, | |
546 "type": "string" | |
547 } | |
548 }, | |
549 "path": "v1/{+name}", | |
550 "response": { | |
551 "$ref": "TransferRun" | |
552 }, | |
553 "scopes": [ | |
554 "https://www.googleapis.com/auth
/bigquery" | |
555 ] | 466 ] |
556 }, | 467 }, |
557 "list": { | 468 "list": { |
558 "description": "Returns information
about running and completed jobs.", | 469 "description": "Returns information
about running and completed jobs.", |
559 "httpMethod": "GET", | 470 "httpMethod": "GET", |
560 "id": "bigquerydatatransfer.projects
.locations.transferConfigs.runs.list", | 471 "id": "bigquerydatatransfer.projects
.locations.transferConfigs.runs.list", |
561 "parameterOrder": [ | 472 "parameterOrder": [ |
562 "parent" | 473 "parent" |
563 ], | 474 ], |
564 "parameters": { | 475 "parameters": { |
565 "pageToken": { | 476 "pageToken": { |
566 "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.", | 477 "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.", |
567 "location": "query", | 478 "location": "query", |
568 "type": "string" | 479 "type": "string" |
569 }, | 480 }, |
| 481 "pageSize": { |
| 482 "description": "Page size. T
he default page size is the maximum value of 1000 results.", |
| 483 "format": "int32", |
| 484 "location": "query", |
| 485 "type": "integer" |
| 486 }, |
570 "statuses": { | 487 "statuses": { |
571 "description": "When specifi
ed, only transfer runs with requested statuses are returned.", | 488 "description": "When specifi
ed, only transfer runs with requested statuses are returned.", |
572 "enum": [ | 489 "enum": [ |
573 "TRANSFER_STATUS_UNSPECI
FIED", | 490 "TRANSFER_STATUS_UNSPECI
FIED", |
574 "INACTIVE", | 491 "INACTIVE", |
575 "PENDING", | 492 "PENDING", |
576 "RUNNING", | 493 "RUNNING", |
577 "SUCCEEDED", | 494 "SUCCEEDED", |
578 "FAILED", | 495 "FAILED", |
579 "CANCELLED" | 496 "CANCELLED" |
580 ], | 497 ], |
581 "location": "query", | 498 "location": "query", |
582 "repeated": true, | 499 "repeated": true, |
583 "type": "string" | 500 "type": "string" |
584 }, | 501 }, |
585 "pageSize": { | |
586 "description": "Page size. T
he default page size is the maximum value of 1000 results.", | |
587 "format": "int32", | |
588 "location": "query", | |
589 "type": "integer" | |
590 }, | |
591 "runAttempt": { | 502 "runAttempt": { |
592 "description": "Indicates ho
w run attempts are to be pulled.", | 503 "description": "Indicates ho
w run attempts are to be pulled.", |
593 "enum": [ | 504 "enum": [ |
594 "RUN_ATTEMPT_UNSPECIFIED
", | 505 "RUN_ATTEMPT_UNSPECIFIED
", |
595 "LATEST" | 506 "LATEST" |
596 ], | 507 ], |
597 "location": "query", | 508 "location": "query", |
598 "type": "string" | 509 "type": "string" |
599 }, | 510 }, |
600 "parent": { | 511 "parent": { |
601 "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}`.", | 512 "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}`.", |
602 "location": "path", | 513 "location": "path", |
603 "pattern": "^projects/[^/]+/
locations/[^/]+/transferConfigs/[^/]+$", | 514 "pattern": "^projects/[^/]+/
locations/[^/]+/transferConfigs/[^/]+$", |
604 "required": true, | 515 "required": true, |
605 "type": "string" | 516 "type": "string" |
606 } | 517 } |
607 }, | 518 }, |
608 "path": "v1/{+parent}/runs", | 519 "path": "v1/{+parent}/runs", |
609 "response": { | 520 "response": { |
610 "$ref": "ListTransferRunsRespons
e" | 521 "$ref": "ListTransferRunsRespons
e" |
611 }, | 522 }, |
612 "scopes": [ | 523 "scopes": [ |
613 "https://www.googleapis.com/auth
/bigquery" | 524 "https://www.googleapis.com/auth
/bigquery", |
| 525 "https://www.googleapis.com/auth
/cloud-platform", |
| 526 "https://www.googleapis.com/auth
/cloud-platform.read-only" |
| 527 ] |
| 528 }, |
| 529 "get": { |
| 530 "description": "Returns information
about the particular transfer run.", |
| 531 "httpMethod": "GET", |
| 532 "id": "bigquerydatatransfer.projects
.locations.transferConfigs.runs.get", |
| 533 "parameterOrder": [ |
| 534 "name" |
| 535 ], |
| 536 "parameters": { |
| 537 "name": { |
| 538 "description": "The field wi
ll contain name of the resource requested, for example:\n`projects/{project_id}/
transferConfigs/{config_id}/runs/{run_id}`", |
| 539 "location": "path", |
| 540 "pattern": "^projects/[^/]+/
locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", |
| 541 "required": true, |
| 542 "type": "string" |
| 543 } |
| 544 }, |
| 545 "path": "v1/{+name}", |
| 546 "response": { |
| 547 "$ref": "TransferRun" |
| 548 }, |
| 549 "scopes": [ |
| 550 "https://www.googleapis.com/auth
/bigquery", |
| 551 "https://www.googleapis.com/auth
/cloud-platform", |
| 552 "https://www.googleapis.com/auth
/cloud-platform.read-only" |
614 ] | 553 ] |
615 } | 554 } |
616 }, | 555 }, |
617 "resources": { | 556 "resources": { |
618 "transferLogs": { | 557 "transferLogs": { |
619 "methods": { | 558 "methods": { |
620 "list": { | 559 "list": { |
621 "description": "Returns user
facing log messages for the data transfer run.", | 560 "description": "Returns user
facing log messages for the data transfer run.", |
622 "httpMethod": "GET", | 561 "httpMethod": "GET", |
623 "id": "bigquerydatatransfer.
projects.locations.transferConfigs.runs.transferLogs.list", | 562 "id": "bigquerydatatransfer.
projects.locations.transferConfigs.runs.transferLogs.list", |
624 "parameterOrder": [ | 563 "parameterOrder": [ |
625 "parent" | 564 "parent" |
626 ], | 565 ], |
627 "parameters": { | 566 "parameters": { |
628 "pageToken": { | |
629 "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.", | |
630 "location": "query", | |
631 "type": "string" | |
632 }, | |
633 "pageSize": { | |
634 "description": "Page
size. The default page size is the maximum value of 1000 results.", | |
635 "format": "int32", | |
636 "location": "query", | |
637 "type": "integer" | |
638 }, | |
639 "messageTypes": { | 567 "messageTypes": { |
640 "description": "Mess
age types to return. If not populated - INFO, WARNING and ERROR\nmessages are re
turned.", | 568 "description": "Mess
age types to return. If not populated - INFO, WARNING and ERROR\nmessages are re
turned.", |
641 "enum": [ | 569 "enum": [ |
642 "MESSAGE_SEVERIT
Y_UNSPECIFIED", | 570 "MESSAGE_SEVERIT
Y_UNSPECIFIED", |
643 "INFO", | 571 "INFO", |
644 "WARNING", | 572 "WARNING", |
645 "ERROR" | 573 "ERROR" |
646 ], | 574 ], |
647 "location": "query", | 575 "location": "query", |
648 "repeated": true, | 576 "repeated": true, |
649 "type": "string" | 577 "type": "string" |
650 }, | 578 }, |
651 "parent": { | 579 "parent": { |
652 "description": "Tran
sfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/r
uns/{run_id}`.", | 580 "description": "Tran
sfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/r
uns/{run_id}`.", |
653 "location": "path", | 581 "location": "path", |
654 "pattern": "^project
s/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", | 582 "pattern": "^project
s/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", |
655 "required": true, | 583 "required": true, |
656 "type": "string" | 584 "type": "string" |
| 585 }, |
| 586 "pageToken": { |
| 587 "description": "Pagi
nation token, which can be used to request a specific page\nof `ListTransferLogs
Request` list results. For multiple-page\nresults, `ListTransferLogsResponse` ou
tputs\na `next_page` token, which can be used as the\n`page_token` value to requ
est the next page of list results.", |
| 588 "location": "query", |
| 589 "type": "string" |
| 590 }, |
| 591 "pageSize": { |
| 592 "description": "Page
size. The default page size is the maximum value of 1000 results.", |
| 593 "format": "int32", |
| 594 "location": "query", |
| 595 "type": "integer" |
657 } | 596 } |
658 }, | 597 }, |
659 "path": "v1/{+parent}/transf
erLogs", | 598 "path": "v1/{+parent}/transf
erLogs", |
660 "response": { | 599 "response": { |
661 "$ref": "ListTransferLog
sResponse" | 600 "$ref": "ListTransferLog
sResponse" |
662 }, | 601 }, |
663 "scopes": [ | 602 "scopes": [ |
664 "https://www.googleapis.
com/auth/bigquery" | 603 "https://www.googleapis.
com/auth/bigquery", |
| 604 "https://www.googleapis.
com/auth/cloud-platform", |
| 605 "https://www.googleapis.
com/auth/cloud-platform.read-only" |
665 ] | 606 ] |
666 } | 607 } |
667 } | 608 } |
668 } | 609 } |
669 } | 610 } |
670 } | 611 } |
671 } | 612 } |
| 613 }, |
| 614 "dataSources": { |
| 615 "methods": { |
| 616 "list": { |
| 617 "description": "Lists supported data sources
and returns their settings,\nwhich can be used for UI rendering.", |
| 618 "httpMethod": "GET", |
| 619 "id": "bigquerydatatransfer.projects.locatio
ns.dataSources.list", |
| 620 "parameterOrder": [ |
| 621 "parent" |
| 622 ], |
| 623 "parameters": { |
| 624 "pageToken": { |
| 625 "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.", |
| 626 "location": "query", |
| 627 "type": "string" |
| 628 }, |
| 629 "pageSize": { |
| 630 "description": "Page size. The defau
lt page size is the maximum value of 1000 results.", |
| 631 "format": "int32", |
| 632 "location": "query", |
| 633 "type": "integer" |
| 634 }, |
| 635 "parent": { |
| 636 "description": "The BigQuery project
id for which data sources should be returned.\nMust be in the form: `projects/{
project_id}`", |
| 637 "location": "path", |
| 638 "pattern": "^projects/[^/]+/location
s/[^/]+$", |
| 639 "required": true, |
| 640 "type": "string" |
| 641 } |
| 642 }, |
| 643 "path": "v1/{+parent}/dataSources", |
| 644 "response": { |
| 645 "$ref": "ListDataSourcesResponse" |
| 646 }, |
| 647 "scopes": [ |
| 648 "https://www.googleapis.com/auth/bigquer
y", |
| 649 "https://www.googleapis.com/auth/cloud-p
latform", |
| 650 "https://www.googleapis.com/auth/cloud-p
latform.read-only" |
| 651 ] |
| 652 }, |
| 653 "get": { |
| 654 "description": "Retrieves a supported data s
ource and returns its settings,\nwhich can be used for UI rendering.", |
| 655 "httpMethod": "GET", |
| 656 "id": "bigquerydatatransfer.projects.locatio
ns.dataSources.get", |
| 657 "parameterOrder": [ |
| 658 "name" |
| 659 ], |
| 660 "parameters": { |
| 661 "name": { |
| 662 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/dataSour
ces/{data_source_id}`", |
| 663 "location": "path", |
| 664 "pattern": "^projects/[^/]+/location
s/[^/]+/dataSources/[^/]+$", |
| 665 "required": true, |
| 666 "type": "string" |
| 667 } |
| 668 }, |
| 669 "path": "v1/{+name}", |
| 670 "response": { |
| 671 "$ref": "DataSource" |
| 672 }, |
| 673 "scopes": [ |
| 674 "https://www.googleapis.com/auth/bigquer
y", |
| 675 "https://www.googleapis.com/auth/cloud-p
latform", |
| 676 "https://www.googleapis.com/auth/cloud-p
latform.read-only" |
| 677 ] |
| 678 }, |
| 679 "checkValidCreds": { |
| 680 "description": "Returns true if valid creden
tials exist for the given data source and\nrequesting user.", |
| 681 "httpMethod": "POST", |
| 682 "id": "bigquerydatatransfer.projects.locatio
ns.dataSources.checkValidCreds", |
| 683 "parameterOrder": [ |
| 684 "name" |
| 685 ], |
| 686 "parameters": { |
| 687 "name": { |
| 688 "description": "The data source in t
he form:\n`projects/{project_id}/dataSources/{data_source_id}`", |
| 689 "location": "path", |
| 690 "pattern": "^projects/[^/]+/location
s/[^/]+/dataSources/[^/]+$", |
| 691 "required": true, |
| 692 "type": "string" |
| 693 } |
| 694 }, |
| 695 "path": "v1/{+name}:checkValidCreds", |
| 696 "request": { |
| 697 "$ref": "CheckValidCredsRequest" |
| 698 }, |
| 699 "response": { |
| 700 "$ref": "CheckValidCredsResponse" |
| 701 }, |
| 702 "scopes": [ |
| 703 "https://www.googleapis.com/auth/bigquer
y", |
| 704 "https://www.googleapis.com/auth/cloud-p
latform", |
| 705 "https://www.googleapis.com/auth/cloud-p
latform.read-only" |
| 706 ] |
| 707 } |
| 708 } |
672 } | 709 } |
673 } | 710 } |
674 }, | 711 }, |
675 "dataSources": { | |
676 "methods": { | |
677 "checkValidCreds": { | |
678 "description": "Returns true if valid credentials ex
ist for the given data source and\nrequesting user.", | |
679 "httpMethod": "POST", | |
680 "id": "bigquerydatatransfer.projects.dataSources.che
ckValidCreds", | |
681 "parameterOrder": [ | |
682 "name" | |
683 ], | |
684 "parameters": { | |
685 "name": { | |
686 "description": "The data source in the form:
\n`projects/{project_id}/dataSources/{data_source_id}`", | |
687 "location": "path", | |
688 "pattern": "^projects/[^/]+/dataSources/[^/]
+$", | |
689 "required": true, | |
690 "type": "string" | |
691 } | |
692 }, | |
693 "path": "v1/{+name}:checkValidCreds", | |
694 "request": { | |
695 "$ref": "CheckValidCredsRequest" | |
696 }, | |
697 "response": { | |
698 "$ref": "CheckValidCredsResponse" | |
699 }, | |
700 "scopes": [ | |
701 "https://www.googleapis.com/auth/bigquery" | |
702 ] | |
703 }, | |
704 "get": { | |
705 "description": "Retrieves a supported data source an
d returns its settings,\nwhich can be used for UI rendering.", | |
706 "httpMethod": "GET", | |
707 "id": "bigquerydatatransfer.projects.dataSources.get
", | |
708 "parameterOrder": [ | |
709 "name" | |
710 ], | |
711 "parameters": { | |
712 "name": { | |
713 "description": "The field will contain name
of the resource requested, for example:\n`projects/{project_id}/dataSources/{dat
a_source_id}`", | |
714 "location": "path", | |
715 "pattern": "^projects/[^/]+/dataSources/[^/]
+$", | |
716 "required": true, | |
717 "type": "string" | |
718 } | |
719 }, | |
720 "path": "v1/{+name}", | |
721 "response": { | |
722 "$ref": "DataSource" | |
723 }, | |
724 "scopes": [ | |
725 "https://www.googleapis.com/auth/bigquery" | |
726 ] | |
727 }, | |
728 "list": { | |
729 "description": "Lists supported data sources and ret
urns their settings,\nwhich can be used for UI rendering.", | |
730 "httpMethod": "GET", | |
731 "id": "bigquerydatatransfer.projects.dataSources.lis
t", | |
732 "parameterOrder": [ | |
733 "parent" | |
734 ], | |
735 "parameters": { | |
736 "pageToken": { | |
737 "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.", | |
738 "location": "query", | |
739 "type": "string" | |
740 }, | |
741 "pageSize": { | |
742 "description": "Page size. The default page
size is the maximum value of 1000 results.", | |
743 "format": "int32", | |
744 "location": "query", | |
745 "type": "integer" | |
746 }, | |
747 "parent": { | |
748 "description": "The BigQuery project id for
which data sources should be returned.\nMust be in the form: `projects/{project_
id}`", | |
749 "location": "path", | |
750 "pattern": "^projects/[^/]+$", | |
751 "required": true, | |
752 "type": "string" | |
753 } | |
754 }, | |
755 "path": "v1/{+parent}/dataSources", | |
756 "response": { | |
757 "$ref": "ListDataSourcesResponse" | |
758 }, | |
759 "scopes": [ | |
760 "https://www.googleapis.com/auth/bigquery" | |
761 ] | |
762 } | |
763 } | |
764 }, | |
765 "transferConfigs": { | 712 "transferConfigs": { |
766 "methods": { | 713 "methods": { |
767 "delete": { | 714 "delete": { |
768 "description": "Deletes a data transfer configuratio
n,\nincluding any associated transfer runs and logs.", | 715 "description": "Deletes a data transfer configuratio
n,\nincluding any associated transfer runs and logs.", |
769 "httpMethod": "DELETE", | 716 "httpMethod": "DELETE", |
770 "id": "bigquerydatatransfer.projects.transferConfigs
.delete", | 717 "id": "bigquerydatatransfer.projects.transferConfigs
.delete", |
771 "parameterOrder": [ | 718 "parameterOrder": [ |
772 "name" | 719 "name" |
773 ], | 720 ], |
774 "parameters": { | 721 "parameters": { |
775 "name": { | 722 "name": { |
776 "description": "The field will contain name
of the resource requested, for example:\n`projects/{project_id}/transferConfigs/
{config_id}`", | 723 "description": "The field will contain name
of the resource requested, for example:\n`projects/{project_id}/transferConfigs/
{config_id}`", |
777 "location": "path", | 724 "location": "path", |
778 "pattern": "^projects/[^/]+/transferConfigs/
[^/]+$", | 725 "pattern": "^projects/[^/]+/transferConfigs/
[^/]+$", |
779 "required": true, | 726 "required": true, |
780 "type": "string" | 727 "type": "string" |
781 } | 728 } |
782 }, | 729 }, |
783 "path": "v1/{+name}", | 730 "path": "v1/{+name}", |
784 "response": { | 731 "response": { |
785 "$ref": "Empty" | 732 "$ref": "Empty" |
786 }, | 733 }, |
787 "scopes": [ | 734 "scopes": [ |
788 "https://www.googleapis.com/auth/bigquery" | 735 "https://www.googleapis.com/auth/bigquery", |
| 736 "https://www.googleapis.com/auth/cloud-platform" |
789 ] | 737 ] |
790 }, | 738 }, |
791 "list": { | 739 "list": { |
792 "description": "Returns information about all data t
ransfers in the project.", | 740 "description": "Returns information about all data t
ransfers in the project.", |
793 "httpMethod": "GET", | 741 "httpMethod": "GET", |
794 "id": "bigquerydatatransfer.projects.transferConfigs
.list", | 742 "id": "bigquerydatatransfer.projects.transferConfigs
.list", |
795 "parameterOrder": [ | 743 "parameterOrder": [ |
796 "parent" | 744 "parent" |
797 ], | 745 ], |
798 "parameters": { | 746 "parameters": { |
799 "pageToken": { | 747 "dataSourceIds": { |
800 "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.", | 748 "description": "When specified, only configu
rations of requested data sources are returned.", |
801 "location": "query", | 749 "location": "query", |
| 750 "repeated": true, |
802 "type": "string" | 751 "type": "string" |
803 }, | 752 }, |
804 "pageSize": { | |
805 "description": "Page size. The default page
size is the maximum value of 1000 results.", | |
806 "format": "int32", | |
807 "location": "query", | |
808 "type": "integer" | |
809 }, | |
810 "parent": { | 753 "parent": { |
811 "description": "The BigQuery project id for
which data sources\nshould be returned: `projects/{project_id}`.", | 754 "description": "The BigQuery project id for
which data sources\nshould be returned: `projects/{project_id}`.", |
812 "location": "path", | 755 "location": "path", |
813 "pattern": "^projects/[^/]+$", | 756 "pattern": "^projects/[^/]+$", |
814 "required": true, | 757 "required": true, |
815 "type": "string" | 758 "type": "string" |
816 }, | 759 }, |
817 "dataSourceIds": { | 760 "pageToken": { |
818 "description": "When specified, only configu
rations of requested data sources are returned.", | 761 "description": "Pagination token, which can
be used to request a specific page\nof `ListTransfersRequest` list results. For
multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, wh
ich can be used as the\n`page_token` value to request the next page of list resu
lts.", |
819 "location": "query", | 762 "location": "query", |
820 "repeated": true, | |
821 "type": "string" | 763 "type": "string" |
| 764 }, |
| 765 "pageSize": { |
| 766 "description": "Page size. The default page
size is the maximum value of 1000 results.", |
| 767 "format": "int32", |
| 768 "location": "query", |
| 769 "type": "integer" |
822 } | 770 } |
823 }, | 771 }, |
824 "path": "v1/{+parent}/transferConfigs", | 772 "path": "v1/{+parent}/transferConfigs", |
825 "response": { | 773 "response": { |
826 "$ref": "ListTransferConfigsResponse" | 774 "$ref": "ListTransferConfigsResponse" |
827 }, | 775 }, |
828 "scopes": [ | 776 "scopes": [ |
829 "https://www.googleapis.com/auth/bigquery" | 777 "https://www.googleapis.com/auth/bigquery", |
| 778 "https://www.googleapis.com/auth/cloud-platform"
, |
| 779 "https://www.googleapis.com/auth/cloud-platform.
read-only" |
830 ] | 780 ] |
831 }, | 781 }, |
832 "create": { | 782 "create": { |
833 "description": "Creates a new data transfer configur
ation.", | 783 "description": "Creates a new data transfer configur
ation.", |
834 "httpMethod": "POST", | 784 "httpMethod": "POST", |
835 "id": "bigquerydatatransfer.projects.transferConfigs
.create", | 785 "id": "bigquerydatatransfer.projects.transferConfigs
.create", |
836 "parameterOrder": [ | 786 "parameterOrder": [ |
837 "parent" | 787 "parent" |
838 ], | 788 ], |
839 "parameters": { | 789 "parameters": { |
| 790 "authorizationCode": { |
| 791 "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
.", |
| 792 "location": "query", |
| 793 "type": "string" |
| 794 }, |
840 "parent": { | 795 "parent": { |
841 "description": "The BigQuery project id wher
e the transfer configuration should be created.", | 796 "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.", |
842 "location": "path", | 797 "location": "path", |
843 "pattern": "^projects/[^/]+$", | 798 "pattern": "^projects/[^/]+$", |
844 "required": true, | 799 "required": true, |
845 "type": "string" | 800 "type": "string" |
846 }, | |
847 "authorizationCode": { | |
848 "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
.", | |
849 "location": "query", | |
850 "type": "string" | |
851 } | 801 } |
852 }, | 802 }, |
853 "path": "v1/{+parent}/transferConfigs", | 803 "path": "v1/{+parent}/transferConfigs", |
854 "request": { | 804 "request": { |
855 "$ref": "TransferConfig" | 805 "$ref": "TransferConfig" |
856 }, | 806 }, |
857 "response": { | 807 "response": { |
858 "$ref": "TransferConfig" | 808 "$ref": "TransferConfig" |
859 }, | 809 }, |
860 "scopes": [ | 810 "scopes": [ |
861 "https://www.googleapis.com/auth/bigquery" | 811 "https://www.googleapis.com/auth/bigquery", |
| 812 "https://www.googleapis.com/auth/cloud-platform" |
862 ] | 813 ] |
863 }, | 814 }, |
864 "scheduleRuns": { | 815 "scheduleRuns": { |
865 "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.", | 816 "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.", |
866 "httpMethod": "POST", | 817 "httpMethod": "POST", |
867 "id": "bigquerydatatransfer.projects.transferConfigs
.scheduleRuns", | 818 "id": "bigquerydatatransfer.projects.transferConfigs
.scheduleRuns", |
868 "parameterOrder": [ | 819 "parameterOrder": [ |
869 "parent" | 820 "parent" |
870 ], | 821 ], |
871 "parameters": { | 822 "parameters": { |
872 "parent": { | 823 "parent": { |
873 "description": "Transfer configuration name
in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.", | 824 "description": "Transfer configuration name
in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.", |
874 "location": "path", | 825 "location": "path", |
875 "pattern": "^projects/[^/]+/transferConfigs/
[^/]+$", | 826 "pattern": "^projects/[^/]+/transferConfigs/
[^/]+$", |
876 "required": true, | 827 "required": true, |
877 "type": "string" | 828 "type": "string" |
878 } | 829 } |
879 }, | 830 }, |
880 "path": "v1/{+parent}:scheduleRuns", | 831 "path": "v1/{+parent}:scheduleRuns", |
881 "request": { | 832 "request": { |
882 "$ref": "ScheduleTransferRunsRequest" | 833 "$ref": "ScheduleTransferRunsRequest" |
883 }, | 834 }, |
884 "response": { | 835 "response": { |
885 "$ref": "ScheduleTransferRunsResponse" | 836 "$ref": "ScheduleTransferRunsResponse" |
886 }, | 837 }, |
887 "scopes": [ | 838 "scopes": [ |
888 "https://www.googleapis.com/auth/bigquery" | 839 "https://www.googleapis.com/auth/bigquery", |
| 840 "https://www.googleapis.com/auth/cloud-platform" |
| 841 ] |
| 842 }, |
| 843 "patch": { |
| 844 "description": "Updates a data transfer configuratio
n.\nAll fields must be set, even if they are not updated.", |
| 845 "httpMethod": "PATCH", |
| 846 "id": "bigquerydatatransfer.projects.transferConfigs
.patch", |
| 847 "parameterOrder": [ |
| 848 "name" |
| 849 ], |
| 850 "parameters": { |
| 851 "name": { |
| 852 "description": "The resource name of the tra
nsfer run.\nTransfer run names have the form\n`projects/{project_id}/transferCon
figs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\n
guaranteed or required. The name is ignored when creating a transfer run.", |
| 853 "location": "path", |
| 854 "pattern": "^projects/[^/]+/transferConfigs/
[^/]+$", |
| 855 "required": true, |
| 856 "type": "string" |
| 857 }, |
| 858 "authorizationCode": { |
| 859 "description": "Optional OAuth2 authorizatio
n code to use with this transfer configuration.\nIf it is provided, the transfer
configuration will be associated with the\ngaia id of the authorizing user.\nIn
order to obtain authorization_code, please make a\nrequest to\nhttps://www.gsta
tic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&sco
pe=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAu
th client_id of BigQuery DTS API for the given\n data source returned by ListDa
taSources method.\n* data_source_scopes are the scopes returned by ListDataSourc
es method.\n* redirect_uri is an optional parameter. If not specified, then\n a
uthorization code is posted to the opener of authorization flow window.\n Other
wise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oaut
h:2.0:oob means that authorization code should be\n returned in the title bar o
f the browser, with the page text prompting\n the user to copy the code and pas
te it in the application.", |
| 860 "location": "query", |
| 861 "type": "string" |
| 862 }, |
| 863 "updateMask": { |
| 864 "description": "Required list of fields to b
e updated in this request.", |
| 865 "format": "google-fieldmask", |
| 866 "location": "query", |
| 867 "type": "string" |
| 868 } |
| 869 }, |
| 870 "path": "v1/{+name}", |
| 871 "request": { |
| 872 "$ref": "TransferConfig" |
| 873 }, |
| 874 "response": { |
| 875 "$ref": "TransferConfig" |
| 876 }, |
| 877 "scopes": [ |
| 878 "https://www.googleapis.com/auth/bigquery", |
| 879 "https://www.googleapis.com/auth/cloud-platform" |
889 ] | 880 ] |
890 }, | 881 }, |
891 "get": { | 882 "get": { |
892 "description": "Returns information about a data tra
nsfer config.", | 883 "description": "Returns information about a data tra
nsfer config.", |
893 "httpMethod": "GET", | 884 "httpMethod": "GET", |
894 "id": "bigquerydatatransfer.projects.transferConfigs
.get", | 885 "id": "bigquerydatatransfer.projects.transferConfigs
.get", |
895 "parameterOrder": [ | 886 "parameterOrder": [ |
896 "name" | 887 "name" |
897 ], | 888 ], |
898 "parameters": { | 889 "parameters": { |
899 "name": { | 890 "name": { |
900 "description": "The field will contain name
of the resource requested, for example:\n`projects/{project_id}/transferConfigs/
{config_id}`", | 891 "description": "The field will contain name
of the resource requested, for example:\n`projects/{project_id}/transferConfigs/
{config_id}`", |
901 "location": "path", | 892 "location": "path", |
902 "pattern": "^projects/[^/]+/transferConfigs/
[^/]+$", | 893 "pattern": "^projects/[^/]+/transferConfigs/
[^/]+$", |
903 "required": true, | 894 "required": true, |
904 "type": "string" | 895 "type": "string" |
905 } | 896 } |
906 }, | 897 }, |
907 "path": "v1/{+name}", | 898 "path": "v1/{+name}", |
908 "response": { | 899 "response": { |
909 "$ref": "TransferConfig" | 900 "$ref": "TransferConfig" |
910 }, | 901 }, |
911 "scopes": [ | 902 "scopes": [ |
912 "https://www.googleapis.com/auth/bigquery" | 903 "https://www.googleapis.com/auth/bigquery", |
913 ] | 904 "https://www.googleapis.com/auth/cloud-platform"
, |
914 }, | 905 "https://www.googleapis.com/auth/cloud-platform.
read-only" |
915 "patch": { | |
916 "description": "Updates a data transfer configuratio
n.\nAll fields must be set, even if they are not updated.", | |
917 "httpMethod": "PATCH", | |
918 "id": "bigquerydatatransfer.projects.transferConfigs
.patch", | |
919 "parameterOrder": [ | |
920 "name" | |
921 ], | |
922 "parameters": { | |
923 "updateMask": { | |
924 "description": "Required list of fields to b
e updated in this request.", | |
925 "format": "google-fieldmask", | |
926 "location": "query", | |
927 "type": "string" | |
928 }, | |
929 "name": { | |
930 "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.", | |
931 "location": "path", | |
932 "pattern": "^projects/[^/]+/transferConfigs/
[^/]+$", | |
933 "required": true, | |
934 "type": "string" | |
935 }, | |
936 "authorizationCode": { | |
937 "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.", | |
938 "location": "query", | |
939 "type": "string" | |
940 } | |
941 }, | |
942 "path": "v1/{+name}", | |
943 "request": { | |
944 "$ref": "TransferConfig" | |
945 }, | |
946 "response": { | |
947 "$ref": "TransferConfig" | |
948 }, | |
949 "scopes": [ | |
950 "https://www.googleapis.com/auth/bigquery" | |
951 ] | 906 ] |
952 } | 907 } |
953 }, | 908 }, |
954 "resources": { | 909 "resources": { |
955 "runs": { | 910 "runs": { |
956 "methods": { | 911 "methods": { |
957 "delete": { | 912 "delete": { |
958 "description": "Deletes the specified transf
er run.", | 913 "description": "Deletes the specified transf
er run.", |
959 "httpMethod": "DELETE", | 914 "httpMethod": "DELETE", |
960 "id": "bigquerydatatransfer.projects.transfe
rConfigs.runs.delete", | 915 "id": "bigquerydatatransfer.projects.transfe
rConfigs.runs.delete", |
961 "parameterOrder": [ | 916 "parameterOrder": [ |
962 "name" | 917 "name" |
963 ], | 918 ], |
964 "parameters": { | 919 "parameters": { |
965 "name": { | 920 "name": { |
966 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/transfer
Configs/{config_id}/runs/{run_id}`", | 921 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/transfer
Configs/{config_id}/runs/{run_id}`", |
967 "location": "path", | 922 "location": "path", |
968 "pattern": "^projects/[^/]+/transfer
Configs/[^/]+/runs/[^/]+$", | 923 "pattern": "^projects/[^/]+/transfer
Configs/[^/]+/runs/[^/]+$", |
969 "required": true, | 924 "required": true, |
970 "type": "string" | 925 "type": "string" |
971 } | 926 } |
972 }, | 927 }, |
973 "path": "v1/{+name}", | 928 "path": "v1/{+name}", |
974 "response": { | 929 "response": { |
975 "$ref": "Empty" | 930 "$ref": "Empty" |
976 }, | 931 }, |
977 "scopes": [ | 932 "scopes": [ |
978 "https://www.googleapis.com/auth/bigquer
y" | 933 "https://www.googleapis.com/auth/bigquer
y", |
979 ] | 934 "https://www.googleapis.com/auth/cloud-p
latform" |
980 }, | |
981 "get": { | |
982 "description": "Returns information about th
e particular transfer run.", | |
983 "httpMethod": "GET", | |
984 "id": "bigquerydatatransfer.projects.transfe
rConfigs.runs.get", | |
985 "parameterOrder": [ | |
986 "name" | |
987 ], | |
988 "parameters": { | |
989 "name": { | |
990 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/transfer
Configs/{config_id}/runs/{run_id}`", | |
991 "location": "path", | |
992 "pattern": "^projects/[^/]+/transfer
Configs/[^/]+/runs/[^/]+$", | |
993 "required": true, | |
994 "type": "string" | |
995 } | |
996 }, | |
997 "path": "v1/{+name}", | |
998 "response": { | |
999 "$ref": "TransferRun" | |
1000 }, | |
1001 "scopes": [ | |
1002 "https://www.googleapis.com/auth/bigquer
y" | |
1003 ] | 935 ] |
1004 }, | 936 }, |
1005 "list": { | 937 "list": { |
1006 "description": "Returns information about ru
nning and completed jobs.", | 938 "description": "Returns information about ru
nning and completed jobs.", |
1007 "httpMethod": "GET", | 939 "httpMethod": "GET", |
1008 "id": "bigquerydatatransfer.projects.transfe
rConfigs.runs.list", | 940 "id": "bigquerydatatransfer.projects.transfe
rConfigs.runs.list", |
1009 "parameterOrder": [ | 941 "parameterOrder": [ |
1010 "parent" | 942 "parent" |
1011 ], | 943 ], |
1012 "parameters": { | 944 "parameters": { |
| 945 "runAttempt": { |
| 946 "description": "Indicates how run at
tempts are to be pulled.", |
| 947 "enum": [ |
| 948 "RUN_ATTEMPT_UNSPECIFIED", |
| 949 "LATEST" |
| 950 ], |
| 951 "location": "query", |
| 952 "type": "string" |
| 953 }, |
1013 "parent": { | 954 "parent": { |
1014 "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}`
.", | 955 "description": "Name of transfer con
figuration for which transfer runs should be retrieved.\nFormat of transfer conf
iguration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`
.", |
1015 "location": "path", | 956 "location": "path", |
1016 "pattern": "^projects/[^/]+/transfer
Configs/[^/]+$", | 957 "pattern": "^projects/[^/]+/transfer
Configs/[^/]+$", |
1017 "required": true, | 958 "required": true, |
1018 "type": "string" | 959 "type": "string" |
1019 }, | 960 }, |
1020 "pageToken": { | 961 "pageToken": { |
1021 "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.", | 962 "description": "Pagination token, wh
ich can be used to request a specific page\nof `ListTransferRunsRequest` list re
sults. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_p
age` token, which can be used as the\n`page_token` value to request the next pag
e of list results.", |
1022 "location": "query", | 963 "location": "query", |
1023 "type": "string" | 964 "type": "string" |
1024 }, | 965 }, |
| 966 "pageSize": { |
| 967 "description": "Page size. The defau
lt page size is the maximum value of 1000 results.", |
| 968 "format": "int32", |
| 969 "location": "query", |
| 970 "type": "integer" |
| 971 }, |
1025 "statuses": { | 972 "statuses": { |
1026 "description": "When specified, only
transfer runs with requested statuses are returned.", | 973 "description": "When specified, only
transfer runs with requested statuses are returned.", |
1027 "enum": [ | 974 "enum": [ |
1028 "TRANSFER_STATUS_UNSPECIFIED", | 975 "TRANSFER_STATUS_UNSPECIFIED", |
1029 "INACTIVE", | 976 "INACTIVE", |
1030 "PENDING", | 977 "PENDING", |
1031 "RUNNING", | 978 "RUNNING", |
1032 "SUCCEEDED", | 979 "SUCCEEDED", |
1033 "FAILED", | 980 "FAILED", |
1034 "CANCELLED" | 981 "CANCELLED" |
1035 ], | 982 ], |
1036 "location": "query", | 983 "location": "query", |
1037 "repeated": true, | 984 "repeated": true, |
1038 "type": "string" | 985 "type": "string" |
1039 }, | |
1040 "pageSize": { | |
1041 "description": "Page size. The defau
lt page size is the maximum value of 1000 results.", | |
1042 "format": "int32", | |
1043 "location": "query", | |
1044 "type": "integer" | |
1045 }, | |
1046 "runAttempt": { | |
1047 "description": "Indicates how run at
tempts are to be pulled.", | |
1048 "enum": [ | |
1049 "RUN_ATTEMPT_UNSPECIFIED", | |
1050 "LATEST" | |
1051 ], | |
1052 "location": "query", | |
1053 "type": "string" | |
1054 } | 986 } |
1055 }, | 987 }, |
1056 "path": "v1/{+parent}/runs", | 988 "path": "v1/{+parent}/runs", |
1057 "response": { | 989 "response": { |
1058 "$ref": "ListTransferRunsResponse" | 990 "$ref": "ListTransferRunsResponse" |
1059 }, | 991 }, |
1060 "scopes": [ | 992 "scopes": [ |
1061 "https://www.googleapis.com/auth/bigquer
y" | 993 "https://www.googleapis.com/auth/bigquer
y", |
| 994 "https://www.googleapis.com/auth/cloud-p
latform", |
| 995 "https://www.googleapis.com/auth/cloud-p
latform.read-only" |
| 996 ] |
| 997 }, |
| 998 "get": { |
| 999 "description": "Returns information about th
e particular transfer run.", |
| 1000 "httpMethod": "GET", |
| 1001 "id": "bigquerydatatransfer.projects.transfe
rConfigs.runs.get", |
| 1002 "parameterOrder": [ |
| 1003 "name" |
| 1004 ], |
| 1005 "parameters": { |
| 1006 "name": { |
| 1007 "description": "The field will conta
in name of the resource requested, for example:\n`projects/{project_id}/transfer
Configs/{config_id}/runs/{run_id}`", |
| 1008 "location": "path", |
| 1009 "pattern": "^projects/[^/]+/transfer
Configs/[^/]+/runs/[^/]+$", |
| 1010 "required": true, |
| 1011 "type": "string" |
| 1012 } |
| 1013 }, |
| 1014 "path": "v1/{+name}", |
| 1015 "response": { |
| 1016 "$ref": "TransferRun" |
| 1017 }, |
| 1018 "scopes": [ |
| 1019 "https://www.googleapis.com/auth/bigquer
y", |
| 1020 "https://www.googleapis.com/auth/cloud-p
latform", |
| 1021 "https://www.googleapis.com/auth/cloud-p
latform.read-only" |
1062 ] | 1022 ] |
1063 } | 1023 } |
1064 }, | 1024 }, |
1065 "resources": { | 1025 "resources": { |
1066 "transferLogs": { | 1026 "transferLogs": { |
1067 "methods": { | 1027 "methods": { |
1068 "list": { | 1028 "list": { |
1069 "description": "Returns user facing
log messages for the data transfer run.", | 1029 "description": "Returns user facing
log messages for the data transfer run.", |
1070 "httpMethod": "GET", | 1030 "httpMethod": "GET", |
1071 "id": "bigquerydatatransfer.projects
.transferConfigs.runs.transferLogs.list", | 1031 "id": "bigquerydatatransfer.projects
.transferConfigs.runs.transferLogs.list", |
(...skipping 30 matching lines...) Expand all Loading... |
1102 "pattern": "^projects/[^/]+/
transferConfigs/[^/]+/runs/[^/]+$", | 1062 "pattern": "^projects/[^/]+/
transferConfigs/[^/]+/runs/[^/]+$", |
1103 "required": true, | 1063 "required": true, |
1104 "type": "string" | 1064 "type": "string" |
1105 } | 1065 } |
1106 }, | 1066 }, |
1107 "path": "v1/{+parent}/transferLogs", | 1067 "path": "v1/{+parent}/transferLogs", |
1108 "response": { | 1068 "response": { |
1109 "$ref": "ListTransferLogsRespons
e" | 1069 "$ref": "ListTransferLogsRespons
e" |
1110 }, | 1070 }, |
1111 "scopes": [ | 1071 "scopes": [ |
1112 "https://www.googleapis.com/auth
/bigquery" | 1072 "https://www.googleapis.com/auth
/bigquery", |
| 1073 "https://www.googleapis.com/auth
/cloud-platform", |
| 1074 "https://www.googleapis.com/auth
/cloud-platform.read-only" |
1113 ] | 1075 ] |
1114 } | 1076 } |
1115 } | 1077 } |
1116 } | 1078 } |
1117 } | 1079 } |
1118 } | 1080 } |
1119 } | 1081 } |
| 1082 }, |
| 1083 "dataSources": { |
| 1084 "methods": { |
| 1085 "list": { |
| 1086 "description": "Lists supported data sources and ret
urns their settings,\nwhich can be used for UI rendering.", |
| 1087 "httpMethod": "GET", |
| 1088 "id": "bigquerydatatransfer.projects.dataSources.lis
t", |
| 1089 "parameterOrder": [ |
| 1090 "parent" |
| 1091 ], |
| 1092 "parameters": { |
| 1093 "pageToken": { |
| 1094 "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.", |
| 1095 "location": "query", |
| 1096 "type": "string" |
| 1097 }, |
| 1098 "pageSize": { |
| 1099 "description": "Page size. The default page
size is the maximum value of 1000 results.", |
| 1100 "format": "int32", |
| 1101 "location": "query", |
| 1102 "type": "integer" |
| 1103 }, |
| 1104 "parent": { |
| 1105 "description": "The BigQuery project id for
which data sources should be returned.\nMust be in the form: `projects/{project_
id}`", |
| 1106 "location": "path", |
| 1107 "pattern": "^projects/[^/]+$", |
| 1108 "required": true, |
| 1109 "type": "string" |
| 1110 } |
| 1111 }, |
| 1112 "path": "v1/{+parent}/dataSources", |
| 1113 "response": { |
| 1114 "$ref": "ListDataSourcesResponse" |
| 1115 }, |
| 1116 "scopes": [ |
| 1117 "https://www.googleapis.com/auth/bigquery", |
| 1118 "https://www.googleapis.com/auth/cloud-platform"
, |
| 1119 "https://www.googleapis.com/auth/cloud-platform.
read-only" |
| 1120 ] |
| 1121 }, |
| 1122 "get": { |
| 1123 "description": "Retrieves a supported data source an
d returns its settings,\nwhich can be used for UI rendering.", |
| 1124 "httpMethod": "GET", |
| 1125 "id": "bigquerydatatransfer.projects.dataSources.get
", |
| 1126 "parameterOrder": [ |
| 1127 "name" |
| 1128 ], |
| 1129 "parameters": { |
| 1130 "name": { |
| 1131 "description": "The field will contain name
of the resource requested, for example:\n`projects/{project_id}/dataSources/{dat
a_source_id}`", |
| 1132 "location": "path", |
| 1133 "pattern": "^projects/[^/]+/dataSources/[^/]
+$", |
| 1134 "required": true, |
| 1135 "type": "string" |
| 1136 } |
| 1137 }, |
| 1138 "path": "v1/{+name}", |
| 1139 "response": { |
| 1140 "$ref": "DataSource" |
| 1141 }, |
| 1142 "scopes": [ |
| 1143 "https://www.googleapis.com/auth/bigquery", |
| 1144 "https://www.googleapis.com/auth/cloud-platform"
, |
| 1145 "https://www.googleapis.com/auth/cloud-platform.
read-only" |
| 1146 ] |
| 1147 }, |
| 1148 "checkValidCreds": { |
| 1149 "description": "Returns true if valid credentials ex
ist for the given data source and\nrequesting user.", |
| 1150 "httpMethod": "POST", |
| 1151 "id": "bigquerydatatransfer.projects.dataSources.che
ckValidCreds", |
| 1152 "parameterOrder": [ |
| 1153 "name" |
| 1154 ], |
| 1155 "parameters": { |
| 1156 "name": { |
| 1157 "description": "The data source in the form:
\n`projects/{project_id}/dataSources/{data_source_id}`", |
| 1158 "location": "path", |
| 1159 "pattern": "^projects/[^/]+/dataSources/[^/]
+$", |
| 1160 "required": true, |
| 1161 "type": "string" |
| 1162 } |
| 1163 }, |
| 1164 "path": "v1/{+name}:checkValidCreds", |
| 1165 "request": { |
| 1166 "$ref": "CheckValidCredsRequest" |
| 1167 }, |
| 1168 "response": { |
| 1169 "$ref": "CheckValidCredsResponse" |
| 1170 }, |
| 1171 "scopes": [ |
| 1172 "https://www.googleapis.com/auth/bigquery", |
| 1173 "https://www.googleapis.com/auth/cloud-platform"
, |
| 1174 "https://www.googleapis.com/auth/cloud-platform.
read-only" |
| 1175 ] |
| 1176 } |
| 1177 } |
1120 } | 1178 } |
1121 } | 1179 } |
1122 } | 1180 } |
1123 }, | 1181 }, |
1124 "revision": "20170609", | 1182 "revision": "20170703", |
1125 "rootUrl": "https://bigquerydatatransfer.googleapis.com/", | 1183 "rootUrl": "https://bigquerydatatransfer.googleapis.com/", |
1126 "schemas": { | 1184 "schemas": { |
1127 "CheckValidCredsResponse": { | |
1128 "description": "A response indicating whether the credentials exist
and are valid.", | |
1129 "id": "CheckValidCredsResponse", | |
1130 "properties": { | |
1131 "hasValidCreds": { | |
1132 "description": "If set to `true`, the credentials exist and
are valid.", | |
1133 "type": "boolean" | |
1134 } | |
1135 }, | |
1136 "type": "object" | |
1137 }, | |
1138 "ScheduleTransferRunsResponse": { | |
1139 "description": "A response to schedule transfer runs for a time rang
e.", | |
1140 "id": "ScheduleTransferRunsResponse", | |
1141 "properties": { | |
1142 "createdRuns": { | |
1143 "description": "The transfer runs that were created.", | |
1144 "items": { | |
1145 "$ref": "TransferRun" | |
1146 }, | |
1147 "type": "array" | |
1148 } | |
1149 }, | |
1150 "type": "object" | |
1151 }, | |
1152 "ListTransferLogsResponse": { | |
1153 "description": "The returned list transfer run messages.", | |
1154 "id": "ListTransferLogsResponse", | |
1155 "properties": { | |
1156 "transferMessages": { | |
1157 "description": "The stored pipeline transfer messages.\n@Out
putOnly", | |
1158 "items": { | |
1159 "$ref": "TransferMessage" | |
1160 }, | |
1161 "type": "array" | |
1162 }, | |
1163 "nextPageToken": { | |
1164 "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", | |
1165 "type": "string" | |
1166 } | |
1167 }, | |
1168 "type": "object" | |
1169 }, | |
1170 "TransferMessage": { | |
1171 "description": "Represents a user facing message for a particular da
ta transfer run.", | |
1172 "id": "TransferMessage", | |
1173 "properties": { | |
1174 "messageTime": { | |
1175 "description": "Time when message was logged.", | |
1176 "format": "google-datetime", | |
1177 "type": "string" | |
1178 }, | |
1179 "severity": { | |
1180 "description": "Message severity.", | |
1181 "enum": [ | |
1182 "MESSAGE_SEVERITY_UNSPECIFIED", | |
1183 "INFO", | |
1184 "WARNING", | |
1185 "ERROR" | |
1186 ], | |
1187 "enumDescriptions": [ | |
1188 "No severity specified.", | |
1189 "Informational message.", | |
1190 "Warning message.", | |
1191 "Error message." | |
1192 ], | |
1193 "type": "string" | |
1194 }, | |
1195 "messageText": { | |
1196 "description": "Message text.", | |
1197 "type": "string" | |
1198 } | |
1199 }, | |
1200 "type": "object" | |
1201 }, | |
1202 "ListDataSourcesResponse": { | |
1203 "description": "Returns list of supported data sources and their met
adata.", | |
1204 "id": "ListDataSourcesResponse", | |
1205 "properties": { | |
1206 "dataSources": { | |
1207 "description": "List of supported data sources and their tra
nsfer settings.", | |
1208 "items": { | |
1209 "$ref": "DataSource" | |
1210 }, | |
1211 "type": "array" | |
1212 }, | |
1213 "nextPageToken": { | |
1214 "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", | |
1215 "type": "string" | |
1216 } | |
1217 }, | |
1218 "type": "object" | |
1219 }, | |
1220 "DataSourceParameter": { | |
1221 "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.", | |
1222 "id": "DataSourceParameter", | |
1223 "properties": { | |
1224 "validationHelpUrl": { | |
1225 "description": "URL to a help document to further explain th
e naming requirements.", | |
1226 "type": "string" | |
1227 }, | |
1228 "minValue": { | |
1229 "description": "For integer and double values specifies mini
mum allowed value.", | |
1230 "format": "double", | |
1231 "type": "number" | |
1232 }, | |
1233 "validationRegex": { | |
1234 "description": "Regular expression which can be used for par
ameter validation.", | |
1235 "type": "string" | |
1236 }, | |
1237 "paramId": { | |
1238 "description": "Parameter identifier.", | |
1239 "type": "string" | |
1240 }, | |
1241 "required": { | |
1242 "description": "Is parameter required.", | |
1243 "type": "boolean" | |
1244 }, | |
1245 "repeated": { | |
1246 "description": "Can parameter have multiple values.", | |
1247 "type": "boolean" | |
1248 }, | |
1249 "displayName": { | |
1250 "description": "Parameter display name in the user interface
.", | |
1251 "type": "string" | |
1252 }, | |
1253 "validationDescription": { | |
1254 "description": "Description of the requirements for this fie
ld, in case the user input does\nnot fulfill the regex pattern or min/max values
.", | |
1255 "type": "string" | |
1256 }, | |
1257 "immutable": { | |
1258 "description": "Cannot be changed after initial creation.", | |
1259 "type": "boolean" | |
1260 }, | |
1261 "fields": { | |
1262 "description": "When parameter is a record, describes child
fields.", | |
1263 "items": { | |
1264 "$ref": "DataSourceParameter" | |
1265 }, | |
1266 "type": "array" | |
1267 }, | |
1268 "maxValue": { | |
1269 "description": "For integer and double values specifies maxm
inum allowed value.", | |
1270 "format": "double", | |
1271 "type": "number" | |
1272 }, | |
1273 "type": { | |
1274 "description": "Parameter type.", | |
1275 "enum": [ | |
1276 "TYPE_UNSPECIFIED", | |
1277 "STRING", | |
1278 "INTEGER", | |
1279 "DOUBLE", | |
1280 "BOOLEAN", | |
1281 "RECORD", | |
1282 "PLUS_PAGE" | |
1283 ], | |
1284 "enumDescriptions": [ | |
1285 "Type unspecified.", | |
1286 "String parameter.", | |
1287 "Integer parameter (64-bits).\nWill be serialized to jso
n as string.", | |
1288 "Double precision floating point parameter.", | |
1289 "Boolean parameter.", | |
1290 "Record parameter.", | |
1291 "Page ID for a Google+ Page." | |
1292 ], | |
1293 "type": "string" | |
1294 }, | |
1295 "recurse": { | |
1296 "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.", | |
1297 "type": "boolean" | |
1298 }, | |
1299 "description": { | |
1300 "description": "Parameter description.", | |
1301 "type": "string" | |
1302 }, | |
1303 "allowedValues": { | |
1304 "description": "All possible values for the parameter.", | |
1305 "items": { | |
1306 "type": "string" | |
1307 }, | |
1308 "type": "array" | |
1309 } | |
1310 }, | |
1311 "type": "object" | |
1312 }, | |
1313 "ListTransferRunsResponse": { | |
1314 "description": "The returned list of pipelines in the project.", | |
1315 "id": "ListTransferRunsResponse", | |
1316 "properties": { | |
1317 "transferRuns": { | |
1318 "description": "The stored pipeline transfer runs.\n@OutputO
nly", | |
1319 "items": { | |
1320 "$ref": "TransferRun" | |
1321 }, | |
1322 "type": "array" | |
1323 }, | |
1324 "nextPageToken": { | |
1325 "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", | |
1326 "type": "string" | |
1327 } | |
1328 }, | |
1329 "type": "object" | |
1330 }, | |
1331 "IsEnabledRequest": { | |
1332 "description": "A request to determine whether data transfer is enab
led for the project.", | |
1333 "id": "IsEnabledRequest", | |
1334 "properties": {}, | |
1335 "type": "object" | |
1336 }, | |
1337 "SetEnabledRequest": { | |
1338 "description": "A request to set whether data transfer is enabled or
disabled for a project.", | |
1339 "id": "SetEnabledRequest", | |
1340 "properties": { | |
1341 "enabled": { | |
1342 "description": "Whether data transfer should be enabled or d
isabled for the project.", | |
1343 "type": "boolean" | |
1344 } | |
1345 }, | |
1346 "type": "object" | |
1347 }, | |
1348 "ListTransferConfigsResponse": { | |
1349 "description": "The returned list of pipelines in the project.", | |
1350 "id": "ListTransferConfigsResponse", | |
1351 "properties": { | |
1352 "transferConfigs": { | |
1353 "description": "The stored pipeline transfer configurations.
\n@OutputOnly", | |
1354 "items": { | |
1355 "$ref": "TransferConfig" | |
1356 }, | |
1357 "type": "array" | |
1358 }, | |
1359 "nextPageToken": { | |
1360 "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", | |
1361 "type": "string" | |
1362 } | |
1363 }, | |
1364 "type": "object" | |
1365 }, | |
1366 "IsEnabledResponse": { | |
1367 "description": "A response to indicate whether data transfer is enab
led for the project.", | |
1368 "id": "IsEnabledResponse", | |
1369 "properties": { | |
1370 "enabled": { | |
1371 "description": "Indicates whether the project is enabled.", | |
1372 "type": "boolean" | |
1373 } | |
1374 }, | |
1375 "type": "object" | |
1376 }, | |
1377 "DataSource": { | 1185 "DataSource": { |
1378 "description": "Represents data source metadata. Metadata is suffici
ent to\nrender UI and request proper OAuth tokens.", | 1186 "description": "Represents data source metadata. Metadata is suffici
ent to\nrender UI and request proper OAuth tokens.", |
1379 "id": "DataSource", | 1187 "id": "DataSource", |
1380 "properties": { | 1188 "properties": { |
1381 "dataSourceId": { | 1189 "name": { |
1382 "description": "Data source id.", | 1190 "description": "Data source resource name.", |
1383 "type": "string" | 1191 "type": "string" |
1384 }, | 1192 }, |
1385 "scopes": { | 1193 "scopes": { |
1386 "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", | 1194 "description": "Api auth scopes for which refresh token need
s to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise.
These are scopes needed\nby a data source to prepare data and ingest them into B
igQuery,\ne.g., https://www.googleapis.com/auth/bigquery", |
1387 "items": { | 1195 "items": { |
1388 "type": "string" | 1196 "type": "string" |
1389 }, | 1197 }, |
1390 "type": "array" | 1198 "type": "array" |
1391 }, | 1199 }, |
1392 "name": { | |
1393 "description": "Data source resource name.", | |
1394 "type": "string" | |
1395 }, | |
1396 "clientId": { | 1200 "clientId": { |
1397 "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.", | 1201 "description": "Data source client id which should be used t
o receive refresh token.\nWhen not supplied, no offline credentials are populate
d for data transfer.", |
1398 "type": "string" | 1202 "type": "string" |
1399 }, | 1203 }, |
1400 "authorizationType": { | 1204 "authorizationType": { |
1401 "description": "Indicates the type of authorization.", | 1205 "description": "Indicates the type of authorization.", |
1402 "enum": [ | 1206 "enum": [ |
1403 "AUTHORIZATION_TYPE_UNSPECIFIED", | 1207 "AUTHORIZATION_TYPE_UNSPECIFIED", |
1404 "AUTHORIZATION_CODE", | 1208 "AUTHORIZATION_CODE", |
1405 "GOOGLE_PLUS_AUTHORIZATION_CODE" | 1209 "GOOGLE_PLUS_AUTHORIZATION_CODE" |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1441 "type": "array" | 1245 "type": "array" |
1442 }, | 1246 }, |
1443 "helpUrl": { | 1247 "helpUrl": { |
1444 "description": "Url for the help document for this data sour
ce.", | 1248 "description": "Url for the help document for this data sour
ce.", |
1445 "type": "string" | 1249 "type": "string" |
1446 }, | 1250 }, |
1447 "defaultSchedule": { | 1251 "defaultSchedule": { |
1448 "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`.", | 1252 "description": "Default data transfer schedule.\nExamples of
valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of j
an,jun 13:15`, and\n`first sunday of quarter 00:00`.", |
1449 "type": "string" | 1253 "type": "string" |
1450 }, | 1254 }, |
| 1255 "supportsMultipleTransfers": { |
| 1256 "description": "Indicates whether the data source supports m
ultiple transfers\nto different BigQuery targets.", |
| 1257 "type": "boolean" |
| 1258 }, |
1451 "statusUpdateDeadlineSeconds": { | 1259 "statusUpdateDeadlineSeconds": { |
1452 "description": "The number of seconds to wait for a status u
pdate from the data source\nbefore BigQuery marks the transfer as failed.", | 1260 "description": "The number of seconds to wait for a status u
pdate from the data source\nbefore BigQuery marks the transfer as failed.", |
1453 "format": "int32", | 1261 "format": "int32", |
1454 "type": "integer" | 1262 "type": "integer" |
1455 }, | 1263 }, |
1456 "supportsMultipleTransfers": { | 1264 "manualRunsDisabled": { |
1457 "description": "Indicates whether the data source supports m
ultiple transfers\nto different BigQuery targets.", | 1265 "description": "Disables backfilling and manual run scheduli
ng\nfor the data source.", |
1458 "type": "boolean" | 1266 "type": "boolean" |
1459 }, | 1267 }, |
1460 "defaultDataRefreshWindowDays": { | 1268 "defaultDataRefreshWindowDays": { |
1461 "description": "Default data refresh window on days.\nOnly m
eaningful when `data_refresh_type` = `SLIDING_WINDOW`.", | 1269 "description": "Default data refresh window on days.\nOnly m
eaningful when `data_refresh_type` = `SLIDING_WINDOW`.", |
1462 "format": "int32", | 1270 "format": "int32", |
1463 "type": "integer" | 1271 "type": "integer" |
1464 }, | 1272 }, |
1465 "manualRunsDisabled": { | |
1466 "description": "Disables backfilling and manual run scheduli
ng\nfor the data source.", | |
1467 "type": "boolean" | |
1468 }, | |
1469 "transferType": { | 1273 "transferType": { |
1470 "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.", | 1274 "description": "Transfer type. Currently supports only batch
transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquer
y) to ingest the data.", |
1471 "enum": [ | 1275 "enum": [ |
1472 "TRANSFER_TYPE_UNSPECIFIED", | 1276 "TRANSFER_TYPE_UNSPECIFIED", |
1473 "BATCH", | 1277 "BATCH", |
1474 "STREAMING" | 1278 "STREAMING" |
1475 ], | 1279 ], |
1476 "enumDescriptions": [ | 1280 "enumDescriptions": [ |
1477 "Invalid or Unknown transfer type placeholder.", | 1281 "Invalid or Unknown transfer type placeholder.", |
1478 "Batch data transfer.", | 1282 "Batch data transfer.", |
1479 "Streaming data transfer. Streaming data source currentl
y doesn't\nsupport multiple transfer configs per project." | 1283 "Streaming data transfer. Streaming data source currentl
y doesn't\nsupport multiple transfer configs per project." |
1480 ], | 1284 ], |
1481 "type": "string" | 1285 "type": "string" |
1482 }, | 1286 }, |
1483 "description": { | 1287 "description": { |
1484 "description": "User friendly data source description string
.", | 1288 "description": "User friendly data source description string
.", |
1485 "type": "string" | 1289 "type": "string" |
| 1290 }, |
| 1291 "dataSourceId": { |
| 1292 "description": "Data source id.", |
| 1293 "type": "string" |
1486 } | 1294 } |
1487 }, | 1295 }, |
1488 "type": "object" | 1296 "type": "object" |
1489 }, | 1297 }, |
1490 "ScheduleTransferRunsRequest": { | 1298 "ScheduleTransferRunsRequest": { |
1491 "description": "A request to schedule transfer runs for a time range
.", | 1299 "description": "A request to schedule transfer runs for a time range
.", |
1492 "id": "ScheduleTransferRunsRequest", | 1300 "id": "ScheduleTransferRunsRequest", |
1493 "properties": { | 1301 "properties": { |
1494 "rangeStartTime": { | 1302 "rangeStartTime": { |
1495 "description": "Start time of the range of transfer runs.", | 1303 "description": "Start time of the range of transfer runs.", |
(...skipping 11 matching lines...) Expand all Loading... |
1507 "Empty": { | 1315 "Empty": { |
1508 "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 `{}`.", | 1316 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
1509 "id": "Empty", | 1317 "id": "Empty", |
1510 "properties": {}, | 1318 "properties": {}, |
1511 "type": "object" | 1319 "type": "object" |
1512 }, | 1320 }, |
1513 "TransferConfig": { | 1321 "TransferConfig": { |
1514 "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.", | 1322 "description": "Represents a data transfer configuration. A transfer
configuration\ncontains all metadata needed to perform a data transfer. For exa
mple,\n`destination_dataset_id` specifies where data should be stored.\nWhen a n
ew transfer configuration is created, the specified\n`destination_dataset_id` is
created when needed and shared with the\nappropriate data source service accoun
t.", |
1515 "id": "TransferConfig", | 1323 "id": "TransferConfig", |
1516 "properties": { | 1324 "properties": { |
| 1325 "datasetRegion": { |
| 1326 "description": "Region in which BigQuery dataset is located.
Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly", |
| 1327 "type": "string" |
| 1328 }, |
| 1329 "displayName": { |
| 1330 "description": "User specified display name for the data tra
nsfer.", |
| 1331 "type": "string" |
| 1332 }, |
1517 "nextRunTime": { | 1333 "nextRunTime": { |
1518 "description": "Next time when data transfer will run. Outpu
t only. Applicable\nonly for batch data transfers.\n@OutputOnly", | 1334 "description": "Next time when data transfer will run. Outpu
t only. Applicable\nonly for batch data transfers.\n@OutputOnly", |
1519 "format": "google-datetime", | 1335 "format": "google-datetime", |
1520 "type": "string" | 1336 "type": "string" |
1521 }, | 1337 }, |
| 1338 "disabled": { |
| 1339 "description": "Is this config disabled. When set to true, n
o runs are scheduled\nfor a given transfer.", |
| 1340 "type": "boolean" |
| 1341 }, |
| 1342 "schedule": { |
| 1343 "description": "Data transfer schedule in GROC format.\nIf t
he data source does not support a custom schedule, this should be\nempty. If it
is empty, the default value for the data source will be\nused.\nThe specified ti
mes are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30
`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.", |
| 1344 "type": "string" |
| 1345 }, |
| 1346 "updateTime": { |
| 1347 "description": "Data transfer modification time. Ignored by
server on input.\n@OutputOnly", |
| 1348 "format": "google-datetime", |
| 1349 "type": "string" |
| 1350 }, |
| 1351 "dataRefreshWindowDays": { |
| 1352 "description": "The number of days to look back to automatic
ally refresh the data.\nFor example, if `data_refresh_window_days = 10`, then ev
ery day\nBigQuery reingests data for [today-10, today-1], rather than ingesting
data\nfor just [today-1].\nOnly valid if the data source supports the feature. S
et the value to 0\nto use the default value.", |
| 1353 "format": "int32", |
| 1354 "type": "integer" |
| 1355 }, |
1522 "dataSourceId": { | 1356 "dataSourceId": { |
1523 "description": "Data source id. Cannot be changed once data
transfer is created.", | 1357 "description": "Data source id. Cannot be changed once data
transfer is created.", |
1524 "type": "string" | 1358 "type": "string" |
1525 }, | 1359 }, |
1526 "disabled": { | |
1527 "description": "Is this config disabled. When set to true, n
o runs are scheduled\nfor a given transfer.", | |
1528 "type": "boolean" | |
1529 }, | |
1530 "status": { | 1360 "status": { |
1531 "description": "Status of the most recently updated transfer
run.\n@OutputOnly", | 1361 "description": "Status of the most recently updated transfer
run.\n@OutputOnly", |
1532 "enum": [ | 1362 "enum": [ |
1533 "TRANSFER_STATUS_UNSPECIFIED", | 1363 "TRANSFER_STATUS_UNSPECIFIED", |
1534 "INACTIVE", | 1364 "INACTIVE", |
1535 "PENDING", | 1365 "PENDING", |
1536 "RUNNING", | 1366 "RUNNING", |
1537 "SUCCEEDED", | 1367 "SUCCEEDED", |
1538 "FAILED", | 1368 "FAILED", |
1539 "CANCELLED" | 1369 "CANCELLED" |
1540 ], | 1370 ], |
1541 "enumDescriptions": [ | 1371 "enumDescriptions": [ |
1542 "Status placeholder.", | 1372 "Status placeholder.", |
1543 "Data transfer is inactive.", | 1373 "Data transfer is inactive.", |
1544 "Data transfer is scheduled and is waiting to be picked
up by\ndata transfer backend.", | 1374 "Data transfer is scheduled and is waiting to be picked
up by\ndata transfer backend.", |
1545 "Data transfer is in progress.", | 1375 "Data transfer is in progress.", |
1546 "Data transfer completed successsfully.", | 1376 "Data transfer completed successsfully.", |
1547 "Data transfer failed.", | 1377 "Data transfer failed.", |
1548 "Data transfer is cancelled." | 1378 "Data transfer is cancelled." |
1549 ], | 1379 ], |
1550 "type": "string" | 1380 "type": "string" |
1551 }, | 1381 }, |
1552 "updateTime": { | 1382 "userId": { |
1553 "description": "Data transfer modification time. Ignored by
server on input.\n@OutputOnly", | 1383 "description": "GaiaID of the user on whose behalf transfer
is done. Applicable only\nto data sources that do not support service accounts.
When set to 0,\nthe data source service account credentials are used.\n@OutputOn
ly", |
1554 "format": "google-datetime", | 1384 "format": "int64", |
1555 "type": "string" | |
1556 }, | |
1557 "schedule": { | |
1558 "description": "Data transfer schedule in GROC format.\nIf t
he data source does not support a custom schedule, this should be\nempty. If it
is empty, the default value for the data source will be\nused.\nThe specified ti
mes are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30
`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.", | |
1559 "type": "string" | 1385 "type": "string" |
1560 }, | 1386 }, |
1561 "destinationDatasetId": { | 1387 "destinationDatasetId": { |
1562 "description": "The BigQuery target dataset id.", | 1388 "description": "The BigQuery target dataset id.", |
1563 "type": "string" | 1389 "type": "string" |
1564 }, | 1390 }, |
1565 "name": { | 1391 "name": { |
1566 "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.", | 1392 "description": "The resource name of the transfer run.\nTran
sfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}
`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or re
quired. The name is ignored when creating a transfer run.", |
1567 "type": "string" | 1393 "type": "string" |
1568 }, | 1394 }, |
1569 "params": { | 1395 "params": { |
1570 "additionalProperties": { | 1396 "additionalProperties": { |
1571 "description": "Properties of the object.", | 1397 "description": "Properties of the object.", |
1572 "type": "any" | 1398 "type": "any" |
1573 }, | 1399 }, |
1574 "description": "Data transfer specific parameters.", | 1400 "description": "Data transfer specific parameters.", |
1575 "type": "object" | 1401 "type": "object" |
1576 }, | |
1577 "dataRefreshWindowDays": { | |
1578 "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.", | |
1579 "format": "int32", | |
1580 "type": "integer" | |
1581 }, | |
1582 "displayName": { | |
1583 "description": "User specified display name for the data tra
nsfer.", | |
1584 "type": "string" | |
1585 } | 1402 } |
1586 }, | 1403 }, |
1587 "type": "object" | 1404 "type": "object" |
1588 }, | 1405 }, |
1589 "TransferRun": { | 1406 "TransferRun": { |
1590 "description": "Represents a data transfer run.", | 1407 "description": "Represents a data transfer run.", |
1591 "id": "TransferRun", | 1408 "id": "TransferRun", |
1592 "properties": { | 1409 "properties": { |
1593 "updateTime": { | 1410 "dataSourceId": { |
1594 "description": "Last time the data transfer run status was u
pdated.\n@OutputOnly", | 1411 "description": "Data source id.\n@OutputOnly", |
1595 "format": "google-datetime", | |
1596 "type": "string" | 1412 "type": "string" |
1597 }, | 1413 }, |
1598 "schedule": { | 1414 "status": { |
1599 "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", | 1415 "description": "Data transfer run status. Ignored for input
requests.\n@OutputOnly", |
| 1416 "enum": [ |
| 1417 "TRANSFER_STATUS_UNSPECIFIED", |
| 1418 "INACTIVE", |
| 1419 "PENDING", |
| 1420 "RUNNING", |
| 1421 "SUCCEEDED", |
| 1422 "FAILED", |
| 1423 "CANCELLED" |
| 1424 ], |
| 1425 "enumDescriptions": [ |
| 1426 "Status placeholder.", |
| 1427 "Data transfer is inactive.", |
| 1428 "Data transfer is scheduled and is waiting to be picked
up by\ndata transfer backend.", |
| 1429 "Data transfer is in progress.", |
| 1430 "Data transfer completed successsfully.", |
| 1431 "Data transfer failed.", |
| 1432 "Data transfer is cancelled." |
| 1433 ], |
| 1434 "type": "string" |
| 1435 }, |
| 1436 "userId": { |
| 1437 "description": "The user id for this transfer run.\n@OutputO
nly", |
| 1438 "format": "int64", |
| 1439 "type": "string" |
| 1440 }, |
| 1441 "name": { |
| 1442 "description": "The resource name of the transfer run.\nTran
sfer run names have the form\n`projects/{project_id}/locations/{location}/transf
erConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a trans
fer run.", |
1600 "type": "string" | 1443 "type": "string" |
1601 }, | 1444 }, |
1602 "destinationDatasetId": { | 1445 "destinationDatasetId": { |
1603 "description": "The BigQuery target dataset id.", | 1446 "description": "The BigQuery target dataset id.", |
1604 "type": "string" | 1447 "type": "string" |
1605 }, | 1448 }, |
1606 "name": { | |
1607 "description": "The resource name of the transfer run.\nTran
sfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}
/runs/{run_id}`.\nThe name is ignored when creating a transfer run.", | |
1608 "type": "string" | |
1609 }, | |
1610 "runTime": { | |
1611 "description": "For batch transfer runs, specifies the date
and time that\ndata should be ingested.", | |
1612 "format": "google-datetime", | |
1613 "type": "string" | |
1614 }, | |
1615 "params": { | 1449 "params": { |
1616 "additionalProperties": { | 1450 "additionalProperties": { |
1617 "description": "Properties of the object.", | 1451 "description": "Properties of the object.", |
1618 "type": "any" | 1452 "type": "any" |
1619 }, | 1453 }, |
1620 "description": "Data transfer specific parameters.", | 1454 "description": "Data transfer specific parameters.", |
1621 "type": "object" | 1455 "type": "object" |
1622 }, | 1456 }, |
1623 "endTime": { | 1457 "endTime": { |
1624 "description": "Time when transfer run ended. Parameter igno
red by server for input\nrequests.\n@OutputOnly", | 1458 "description": "Time when transfer run ended. Parameter igno
red by server for input\nrequests.\n@OutputOnly", |
1625 "format": "google-datetime", | 1459 "format": "google-datetime", |
1626 "type": "string" | 1460 "type": "string" |
1627 }, | 1461 }, |
1628 "startTime": { | 1462 "startTime": { |
1629 "description": "Time when transfer run was started. Paramete
r ignored by server for input\nrequests.\n@OutputOnly", | 1463 "description": "Time when transfer run was started. Paramete
r ignored by server for input\nrequests.\n@OutputOnly", |
1630 "format": "google-datetime", | 1464 "format": "google-datetime", |
1631 "type": "string" | 1465 "type": "string" |
1632 }, | 1466 }, |
1633 "dataSourceId": { | 1467 "datasetRegion": { |
1634 "description": "Data source id.\n@OutputOnly", | 1468 "description": "Region in which BigQuery dataset is located.
Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly", |
1635 "type": "string" | 1469 "type": "string" |
1636 }, | 1470 }, |
1637 "scheduleTime": { | 1471 "scheduleTime": { |
1638 "description": "Minimum time after which a transfer run can
be started.", | 1472 "description": "Minimum time after which a transfer run can
be started.", |
1639 "format": "google-datetime", | 1473 "format": "google-datetime", |
1640 "type": "string" | 1474 "type": "string" |
1641 }, | 1475 }, |
1642 "status": { | 1476 "schedule": { |
1643 "description": "Data transfer run status. Ignored for input
requests.\n@OutputOnly", | 1477 "description": "Describes the schedule of this transfer run
if it was created as part of\na regular schedule. For batch transfer runs that a
re directly created,\nthis is empty.\nNOTE: the system might choose to delay the
schedule depending on the\ncurrent load, so `schedule_time` doesn't always matc
hes this.\n@OutputOnly", |
1644 "enum": [ | 1478 "type": "string" |
1645 "TRANSFER_STATUS_UNSPECIFIED", | 1479 }, |
1646 "INACTIVE", | 1480 "updateTime": { |
1647 "PENDING", | 1481 "description": "Last time the data transfer run status was u
pdated.\n@OutputOnly", |
1648 "RUNNING", | 1482 "format": "google-datetime", |
1649 "SUCCEEDED", | 1483 "type": "string" |
1650 "FAILED", | 1484 }, |
1651 "CANCELLED" | 1485 "runTime": { |
1652 ], | 1486 "description": "For batch transfer runs, specifies the date
and time that\ndata should be ingested.", |
1653 "enumDescriptions": [ | 1487 "format": "google-datetime", |
1654 "Status placeholder.", | |
1655 "Data transfer is inactive.", | |
1656 "Data transfer is scheduled and is waiting to be picked
up by\ndata transfer backend.", | |
1657 "Data transfer is in progress.", | |
1658 "Data transfer completed successsfully.", | |
1659 "Data transfer failed.", | |
1660 "Data transfer is cancelled." | |
1661 ], | |
1662 "type": "string" | 1488 "type": "string" |
1663 } | 1489 } |
1664 }, | 1490 }, |
1665 "type": "object" | 1491 "type": "object" |
1666 }, | 1492 }, |
1667 "CheckValidCredsRequest": { | 1493 "CheckValidCredsRequest": { |
1668 "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.", | 1494 "description": "A request to determine whether the user has valid cr
edentials. This method\nis used to limit the number of OAuth popups in the user
interface. The\nuser id is inferred from the API call context.\nIf the data sour
ce has the Google+ authorization type, this method\nreturns false, as it cannot
be determined whether the credentials are\nalready valid merely based on the use
r id.", |
1669 "id": "CheckValidCredsRequest", | 1495 "id": "CheckValidCredsRequest", |
1670 "properties": {}, | 1496 "properties": {}, |
1671 "type": "object" | 1497 "type": "object" |
| 1498 }, |
| 1499 "CheckValidCredsResponse": { |
| 1500 "description": "A response indicating whether the credentials exist
and are valid.", |
| 1501 "id": "CheckValidCredsResponse", |
| 1502 "properties": { |
| 1503 "hasValidCreds": { |
| 1504 "description": "If set to `true`, the credentials exist and
are valid.", |
| 1505 "type": "boolean" |
| 1506 } |
| 1507 }, |
| 1508 "type": "object" |
| 1509 }, |
| 1510 "ScheduleTransferRunsResponse": { |
| 1511 "description": "A response to schedule transfer runs for a time rang
e.", |
| 1512 "id": "ScheduleTransferRunsResponse", |
| 1513 "properties": { |
| 1514 "createdRuns": { |
| 1515 "description": "The transfer runs that were created.", |
| 1516 "items": { |
| 1517 "$ref": "TransferRun" |
| 1518 }, |
| 1519 "type": "array" |
| 1520 } |
| 1521 }, |
| 1522 "type": "object" |
| 1523 }, |
| 1524 "ListTransferLogsResponse": { |
| 1525 "description": "The returned list transfer run messages.", |
| 1526 "id": "ListTransferLogsResponse", |
| 1527 "properties": { |
| 1528 "nextPageToken": { |
| 1529 "description": "The next-pagination token. For multiple-page
list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_to
ken`\nto request the next page of list results.\n@OutputOnly", |
| 1530 "type": "string" |
| 1531 }, |
| 1532 "transferMessages": { |
| 1533 "description": "The stored pipeline transfer messages.\n@Out
putOnly", |
| 1534 "items": { |
| 1535 "$ref": "TransferMessage" |
| 1536 }, |
| 1537 "type": "array" |
| 1538 } |
| 1539 }, |
| 1540 "type": "object" |
| 1541 }, |
| 1542 "TransferMessage": { |
| 1543 "description": "Represents a user facing message for a particular da
ta transfer run.", |
| 1544 "id": "TransferMessage", |
| 1545 "properties": { |
| 1546 "messageText": { |
| 1547 "description": "Message text.", |
| 1548 "type": "string" |
| 1549 }, |
| 1550 "severity": { |
| 1551 "description": "Message severity.", |
| 1552 "enum": [ |
| 1553 "MESSAGE_SEVERITY_UNSPECIFIED", |
| 1554 "INFO", |
| 1555 "WARNING", |
| 1556 "ERROR" |
| 1557 ], |
| 1558 "enumDescriptions": [ |
| 1559 "No severity specified.", |
| 1560 "Informational message.", |
| 1561 "Warning message.", |
| 1562 "Error message." |
| 1563 ], |
| 1564 "type": "string" |
| 1565 }, |
| 1566 "messageTime": { |
| 1567 "description": "Time when message was logged.", |
| 1568 "format": "google-datetime", |
| 1569 "type": "string" |
| 1570 } |
| 1571 }, |
| 1572 "type": "object" |
| 1573 }, |
| 1574 "ListDataSourcesResponse": { |
| 1575 "description": "Returns list of supported data sources and their met
adata.", |
| 1576 "id": "ListDataSourcesResponse", |
| 1577 "properties": { |
| 1578 "nextPageToken": { |
| 1579 "description": "The next-pagination token. For multiple-page
list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_toke
n`\nto request the next page of list results.\n@OutputOnly", |
| 1580 "type": "string" |
| 1581 }, |
| 1582 "dataSources": { |
| 1583 "description": "List of supported data sources and their tra
nsfer settings.", |
| 1584 "items": { |
| 1585 "$ref": "DataSource" |
| 1586 }, |
| 1587 "type": "array" |
| 1588 } |
| 1589 }, |
| 1590 "type": "object" |
| 1591 }, |
| 1592 "DataSourceParameter": { |
| 1593 "description": "Represents a data source parameter with validation r
ules, so that\nparameters can be rendered in the UI. These parameters are given
to us by\nsupported data sources, and include all needed information for renderi
ng\nand validation.\nThus, whoever uses this api can decide to generate either g
eneric ui,\nor custom data source specific forms.", |
| 1594 "id": "DataSourceParameter", |
| 1595 "properties": { |
| 1596 "fields": { |
| 1597 "description": "When parameter is a record, describes child
fields.", |
| 1598 "items": { |
| 1599 "$ref": "DataSourceParameter" |
| 1600 }, |
| 1601 "type": "array" |
| 1602 }, |
| 1603 "maxValue": { |
| 1604 "description": "For integer and double values specifies maxm
inum allowed value.", |
| 1605 "format": "double", |
| 1606 "type": "number" |
| 1607 }, |
| 1608 "type": { |
| 1609 "description": "Parameter type.", |
| 1610 "enum": [ |
| 1611 "TYPE_UNSPECIFIED", |
| 1612 "STRING", |
| 1613 "INTEGER", |
| 1614 "DOUBLE", |
| 1615 "BOOLEAN", |
| 1616 "RECORD", |
| 1617 "PLUS_PAGE" |
| 1618 ], |
| 1619 "enumDescriptions": [ |
| 1620 "Type unspecified.", |
| 1621 "String parameter.", |
| 1622 "Integer parameter (64-bits).\nWill be serialized to jso
n as string.", |
| 1623 "Double precision floating point parameter.", |
| 1624 "Boolean parameter.", |
| 1625 "Record parameter.", |
| 1626 "Page ID for a Google+ Page." |
| 1627 ], |
| 1628 "type": "string" |
| 1629 }, |
| 1630 "recurse": { |
| 1631 "description": "If set to true, schema should be taken from
the parent with the same\nparameter_id. Only applicable when parameter type is R
ECORD.", |
| 1632 "type": "boolean" |
| 1633 }, |
| 1634 "description": { |
| 1635 "description": "Parameter description.", |
| 1636 "type": "string" |
| 1637 }, |
| 1638 "allowedValues": { |
| 1639 "description": "All possible values for the parameter.", |
| 1640 "items": { |
| 1641 "type": "string" |
| 1642 }, |
| 1643 "type": "array" |
| 1644 }, |
| 1645 "validationHelpUrl": { |
| 1646 "description": "URL to a help document to further explain th
e naming requirements.", |
| 1647 "type": "string" |
| 1648 }, |
| 1649 "minValue": { |
| 1650 "description": "For integer and double values specifies mini
mum allowed value.", |
| 1651 "format": "double", |
| 1652 "type": "number" |
| 1653 }, |
| 1654 "validationRegex": { |
| 1655 "description": "Regular expression which can be used for par
ameter validation.", |
| 1656 "type": "string" |
| 1657 }, |
| 1658 "paramId": { |
| 1659 "description": "Parameter identifier.", |
| 1660 "type": "string" |
| 1661 }, |
| 1662 "required": { |
| 1663 "description": "Is parameter required.", |
| 1664 "type": "boolean" |
| 1665 }, |
| 1666 "repeated": { |
| 1667 "description": "Can parameter have multiple values.", |
| 1668 "type": "boolean" |
| 1669 }, |
| 1670 "displayName": { |
| 1671 "description": "Parameter display name in the user interface
.", |
| 1672 "type": "string" |
| 1673 }, |
| 1674 "validationDescription": { |
| 1675 "description": "Description of the requirements for this fie
ld, in case the user input does\nnot fulfill the regex pattern or min/max values
.", |
| 1676 "type": "string" |
| 1677 }, |
| 1678 "immutable": { |
| 1679 "description": "Cannot be changed after initial creation.", |
| 1680 "type": "boolean" |
| 1681 } |
| 1682 }, |
| 1683 "type": "object" |
| 1684 }, |
| 1685 "ListTransferRunsResponse": { |
| 1686 "description": "The returned list of pipelines in the project.", |
| 1687 "id": "ListTransferRunsResponse", |
| 1688 "properties": { |
| 1689 "nextPageToken": { |
| 1690 "description": "The next-pagination token. For multiple-page
list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_tok
en`\nto request the next page of list results.\n@OutputOnly", |
| 1691 "type": "string" |
| 1692 }, |
| 1693 "transferRuns": { |
| 1694 "description": "The stored pipeline transfer runs.\n@OutputO
nly", |
| 1695 "items": { |
| 1696 "$ref": "TransferRun" |
| 1697 }, |
| 1698 "type": "array" |
| 1699 } |
| 1700 }, |
| 1701 "type": "object" |
| 1702 }, |
| 1703 "IsEnabledRequest": { |
| 1704 "description": "A request to determine whether data transfer is enab
led for the project.", |
| 1705 "id": "IsEnabledRequest", |
| 1706 "properties": {}, |
| 1707 "type": "object" |
| 1708 }, |
| 1709 "ListTransferConfigsResponse": { |
| 1710 "description": "The returned list of pipelines in the project.", |
| 1711 "id": "ListTransferConfigsResponse", |
| 1712 "properties": { |
| 1713 "transferConfigs": { |
| 1714 "description": "The stored pipeline transfer configurations.
\n@OutputOnly", |
| 1715 "items": { |
| 1716 "$ref": "TransferConfig" |
| 1717 }, |
| 1718 "type": "array" |
| 1719 }, |
| 1720 "nextPageToken": { |
| 1721 "description": "The next-pagination token. For multiple-page
list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_
token`\nto request the next page of list results.\n@OutputOnly", |
| 1722 "type": "string" |
| 1723 } |
| 1724 }, |
| 1725 "type": "object" |
| 1726 }, |
| 1727 "SetEnabledRequest": { |
| 1728 "description": "A request to set whether data transfer is enabled or
disabled for a project.", |
| 1729 "id": "SetEnabledRequest", |
| 1730 "properties": { |
| 1731 "enabled": { |
| 1732 "description": "Whether data transfer should be enabled or d
isabled for the project.", |
| 1733 "type": "boolean" |
| 1734 } |
| 1735 }, |
| 1736 "type": "object" |
| 1737 }, |
| 1738 "IsEnabledResponse": { |
| 1739 "description": "A response to indicate whether data transfer is enab
led for the project.", |
| 1740 "id": "IsEnabledResponse", |
| 1741 "properties": { |
| 1742 "enabled": { |
| 1743 "description": "Indicates whether the project is enabled.", |
| 1744 "type": "boolean" |
| 1745 } |
| 1746 }, |
| 1747 "type": "object" |
1672 } | 1748 } |
1673 }, | 1749 }, |
1674 "servicePath": "", | 1750 "servicePath": "", |
1675 "title": "BigQuery Data Transfer Service API", | 1751 "title": "BigQuery Data Transfer Service API", |
1676 "version": "v1" | 1752 "version": "v1" |
1677 } | 1753 } |
OLD | NEW |