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