1"""Generated client library for bigquerydatatransfer version v1.""" 2# NOTE: This file is autogenerated and should not be edited by hand. 3 4from __future__ import absolute_import 5 6from apitools.base.py import base_api 7from googlecloudsdk.third_party.apis.bigquerydatatransfer.v1 import bigquerydatatransfer_v1_messages as messages 8 9 10class BigquerydatatransferV1(base_api.BaseApiClient): 11 """Generated client library for service bigquerydatatransfer version v1.""" 12 13 MESSAGES_MODULE = messages 14 BASE_URL = 'https://bigquerydatatransfer.googleapis.com/' 15 MTLS_BASE_URL = 'https://bigquerydatatransfer.mtls.googleapis.com/' 16 17 _PACKAGE = 'bigquerydatatransfer' 18 _SCOPES = ['https://www.googleapis.com/auth/bigquery', 'https://www.googleapis.com/auth/bigquery.readonly', 'https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-platform.read-only'] 19 _VERSION = 'v1' 20 _CLIENT_ID = '1042881264118.apps.googleusercontent.com' 21 _CLIENT_SECRET = 'x_Tw5K8nnjoRAqULM9PFAC2b' 22 _USER_AGENT = 'google-cloud-sdk' 23 _CLIENT_CLASS_NAME = 'BigquerydatatransferV1' 24 _URL_VERSION = 'v1' 25 _API_KEY = None 26 27 def __init__(self, url='', credentials=None, 28 get_credentials=True, http=None, model=None, 29 log_request=False, log_response=False, 30 credentials_args=None, default_global_params=None, 31 additional_http_headers=None, response_encoding=None): 32 """Create a new bigquerydatatransfer handle.""" 33 url = url or self.BASE_URL 34 super(BigquerydatatransferV1, self).__init__( 35 url, credentials=credentials, 36 get_credentials=get_credentials, http=http, model=model, 37 log_request=log_request, log_response=log_response, 38 credentials_args=credentials_args, 39 default_global_params=default_global_params, 40 additional_http_headers=additional_http_headers, 41 response_encoding=response_encoding) 42 self.projects_dataSources = self.ProjectsDataSourcesService(self) 43 self.projects_locations_dataSources = self.ProjectsLocationsDataSourcesService(self) 44 self.projects_locations_transferConfigs_runs_transferLogs = self.ProjectsLocationsTransferConfigsRunsTransferLogsService(self) 45 self.projects_locations_transferConfigs_runs = self.ProjectsLocationsTransferConfigsRunsService(self) 46 self.projects_locations_transferConfigs = self.ProjectsLocationsTransferConfigsService(self) 47 self.projects_locations = self.ProjectsLocationsService(self) 48 self.projects_transferConfigs_runs_transferLogs = self.ProjectsTransferConfigsRunsTransferLogsService(self) 49 self.projects_transferConfigs_runs = self.ProjectsTransferConfigsRunsService(self) 50 self.projects_transferConfigs = self.ProjectsTransferConfigsService(self) 51 self.projects = self.ProjectsService(self) 52 53 class ProjectsDataSourcesService(base_api.BaseApiService): 54 """Service class for the projects_dataSources resource.""" 55 56 _NAME = 'projects_dataSources' 57 58 def __init__(self, client): 59 super(BigquerydatatransferV1.ProjectsDataSourcesService, self).__init__(client) 60 self._upload_configs = { 61 } 62 63 def CheckValidCreds(self, request, global_params=None): 64 r"""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. 65 66 Args: 67 request: (BigquerydatatransferProjectsDataSourcesCheckValidCredsRequest) input message 68 global_params: (StandardQueryParameters, default: None) global arguments 69 Returns: 70 (CheckValidCredsResponse) The response message. 71 """ 72 config = self.GetMethodConfig('CheckValidCreds') 73 return self._RunMethod( 74 config, request, global_params=global_params) 75 76 CheckValidCreds.method_config = lambda: base_api.ApiMethodInfo( 77 flat_path='v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds', 78 http_method='POST', 79 method_id='bigquerydatatransfer.projects.dataSources.checkValidCreds', 80 ordered_params=['name'], 81 path_params=['name'], 82 query_params=[], 83 relative_path='v1/{+name}:checkValidCreds', 84 request_field='checkValidCredsRequest', 85 request_type_name='BigquerydatatransferProjectsDataSourcesCheckValidCredsRequest', 86 response_type_name='CheckValidCredsResponse', 87 supports_download=False, 88 ) 89 90 def Get(self, request, global_params=None): 91 r"""Retrieves a supported data source and returns its settings, which can be used for UI rendering. 92 93 Args: 94 request: (BigquerydatatransferProjectsDataSourcesGetRequest) input message 95 global_params: (StandardQueryParameters, default: None) global arguments 96 Returns: 97 (DataSource) The response message. 98 """ 99 config = self.GetMethodConfig('Get') 100 return self._RunMethod( 101 config, request, global_params=global_params) 102 103 Get.method_config = lambda: base_api.ApiMethodInfo( 104 flat_path='v1/projects/{projectsId}/dataSources/{dataSourcesId}', 105 http_method='GET', 106 method_id='bigquerydatatransfer.projects.dataSources.get', 107 ordered_params=['name'], 108 path_params=['name'], 109 query_params=[], 110 relative_path='v1/{+name}', 111 request_field='', 112 request_type_name='BigquerydatatransferProjectsDataSourcesGetRequest', 113 response_type_name='DataSource', 114 supports_download=False, 115 ) 116 117 def List(self, request, global_params=None): 118 r"""Lists supported data sources and returns their settings, which can be used for UI rendering. 119 120 Args: 121 request: (BigquerydatatransferProjectsDataSourcesListRequest) input message 122 global_params: (StandardQueryParameters, default: None) global arguments 123 Returns: 124 (ListDataSourcesResponse) The response message. 125 """ 126 config = self.GetMethodConfig('List') 127 return self._RunMethod( 128 config, request, global_params=global_params) 129 130 List.method_config = lambda: base_api.ApiMethodInfo( 131 flat_path='v1/projects/{projectsId}/dataSources', 132 http_method='GET', 133 method_id='bigquerydatatransfer.projects.dataSources.list', 134 ordered_params=['parent'], 135 path_params=['parent'], 136 query_params=['pageSize', 'pageToken'], 137 relative_path='v1/{+parent}/dataSources', 138 request_field='', 139 request_type_name='BigquerydatatransferProjectsDataSourcesListRequest', 140 response_type_name='ListDataSourcesResponse', 141 supports_download=False, 142 ) 143 144 class ProjectsLocationsDataSourcesService(base_api.BaseApiService): 145 """Service class for the projects_locations_dataSources resource.""" 146 147 _NAME = 'projects_locations_dataSources' 148 149 def __init__(self, client): 150 super(BigquerydatatransferV1.ProjectsLocationsDataSourcesService, self).__init__(client) 151 self._upload_configs = { 152 } 153 154 def CheckValidCreds(self, request, global_params=None): 155 r"""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. 156 157 Args: 158 request: (BigquerydatatransferProjectsLocationsDataSourcesCheckValidCredsRequest) input message 159 global_params: (StandardQueryParameters, default: None) global arguments 160 Returns: 161 (CheckValidCredsResponse) The response message. 162 """ 163 config = self.GetMethodConfig('CheckValidCreds') 164 return self._RunMethod( 165 config, request, global_params=global_params) 166 167 CheckValidCreds.method_config = lambda: base_api.ApiMethodInfo( 168 flat_path='v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds', 169 http_method='POST', 170 method_id='bigquerydatatransfer.projects.locations.dataSources.checkValidCreds', 171 ordered_params=['name'], 172 path_params=['name'], 173 query_params=[], 174 relative_path='v1/{+name}:checkValidCreds', 175 request_field='checkValidCredsRequest', 176 request_type_name='BigquerydatatransferProjectsLocationsDataSourcesCheckValidCredsRequest', 177 response_type_name='CheckValidCredsResponse', 178 supports_download=False, 179 ) 180 181 def Get(self, request, global_params=None): 182 r"""Retrieves a supported data source and returns its settings, which can be used for UI rendering. 183 184 Args: 185 request: (BigquerydatatransferProjectsLocationsDataSourcesGetRequest) input message 186 global_params: (StandardQueryParameters, default: None) global arguments 187 Returns: 188 (DataSource) The response message. 189 """ 190 config = self.GetMethodConfig('Get') 191 return self._RunMethod( 192 config, request, global_params=global_params) 193 194 Get.method_config = lambda: base_api.ApiMethodInfo( 195 flat_path='v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}', 196 http_method='GET', 197 method_id='bigquerydatatransfer.projects.locations.dataSources.get', 198 ordered_params=['name'], 199 path_params=['name'], 200 query_params=[], 201 relative_path='v1/{+name}', 202 request_field='', 203 request_type_name='BigquerydatatransferProjectsLocationsDataSourcesGetRequest', 204 response_type_name='DataSource', 205 supports_download=False, 206 ) 207 208 def List(self, request, global_params=None): 209 r"""Lists supported data sources and returns their settings, which can be used for UI rendering. 210 211 Args: 212 request: (BigquerydatatransferProjectsLocationsDataSourcesListRequest) input message 213 global_params: (StandardQueryParameters, default: None) global arguments 214 Returns: 215 (ListDataSourcesResponse) The response message. 216 """ 217 config = self.GetMethodConfig('List') 218 return self._RunMethod( 219 config, request, global_params=global_params) 220 221 List.method_config = lambda: base_api.ApiMethodInfo( 222 flat_path='v1/projects/{projectsId}/locations/{locationsId}/dataSources', 223 http_method='GET', 224 method_id='bigquerydatatransfer.projects.locations.dataSources.list', 225 ordered_params=['parent'], 226 path_params=['parent'], 227 query_params=['pageSize', 'pageToken'], 228 relative_path='v1/{+parent}/dataSources', 229 request_field='', 230 request_type_name='BigquerydatatransferProjectsLocationsDataSourcesListRequest', 231 response_type_name='ListDataSourcesResponse', 232 supports_download=False, 233 ) 234 235 class ProjectsLocationsTransferConfigsRunsTransferLogsService(base_api.BaseApiService): 236 """Service class for the projects_locations_transferConfigs_runs_transferLogs resource.""" 237 238 _NAME = 'projects_locations_transferConfigs_runs_transferLogs' 239 240 def __init__(self, client): 241 super(BigquerydatatransferV1.ProjectsLocationsTransferConfigsRunsTransferLogsService, self).__init__(client) 242 self._upload_configs = { 243 } 244 245 def List(self, request, global_params=None): 246 r"""Returns user facing log messages for the data transfer run. 247 248 Args: 249 request: (BigquerydatatransferProjectsLocationsTransferConfigsRunsTransferLogsListRequest) input message 250 global_params: (StandardQueryParameters, default: None) global arguments 251 Returns: 252 (ListTransferLogsResponse) The response message. 253 """ 254 config = self.GetMethodConfig('List') 255 return self._RunMethod( 256 config, request, global_params=global_params) 257 258 List.method_config = lambda: base_api.ApiMethodInfo( 259 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs', 260 http_method='GET', 261 method_id='bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list', 262 ordered_params=['parent'], 263 path_params=['parent'], 264 query_params=['messageTypes', 'pageSize', 'pageToken'], 265 relative_path='v1/{+parent}/transferLogs', 266 request_field='', 267 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsRunsTransferLogsListRequest', 268 response_type_name='ListTransferLogsResponse', 269 supports_download=False, 270 ) 271 272 class ProjectsLocationsTransferConfigsRunsService(base_api.BaseApiService): 273 """Service class for the projects_locations_transferConfigs_runs resource.""" 274 275 _NAME = 'projects_locations_transferConfigs_runs' 276 277 def __init__(self, client): 278 super(BigquerydatatransferV1.ProjectsLocationsTransferConfigsRunsService, self).__init__(client) 279 self._upload_configs = { 280 } 281 282 def Delete(self, request, global_params=None): 283 r"""Deletes the specified transfer run. 284 285 Args: 286 request: (BigquerydatatransferProjectsLocationsTransferConfigsRunsDeleteRequest) input message 287 global_params: (StandardQueryParameters, default: None) global arguments 288 Returns: 289 (Empty) The response message. 290 """ 291 config = self.GetMethodConfig('Delete') 292 return self._RunMethod( 293 config, request, global_params=global_params) 294 295 Delete.method_config = lambda: base_api.ApiMethodInfo( 296 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}', 297 http_method='DELETE', 298 method_id='bigquerydatatransfer.projects.locations.transferConfigs.runs.delete', 299 ordered_params=['name'], 300 path_params=['name'], 301 query_params=[], 302 relative_path='v1/{+name}', 303 request_field='', 304 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsRunsDeleteRequest', 305 response_type_name='Empty', 306 supports_download=False, 307 ) 308 309 def Get(self, request, global_params=None): 310 r"""Returns information about the particular transfer run. 311 312 Args: 313 request: (BigquerydatatransferProjectsLocationsTransferConfigsRunsGetRequest) input message 314 global_params: (StandardQueryParameters, default: None) global arguments 315 Returns: 316 (TransferRun) The response message. 317 """ 318 config = self.GetMethodConfig('Get') 319 return self._RunMethod( 320 config, request, global_params=global_params) 321 322 Get.method_config = lambda: base_api.ApiMethodInfo( 323 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}', 324 http_method='GET', 325 method_id='bigquerydatatransfer.projects.locations.transferConfigs.runs.get', 326 ordered_params=['name'], 327 path_params=['name'], 328 query_params=[], 329 relative_path='v1/{+name}', 330 request_field='', 331 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsRunsGetRequest', 332 response_type_name='TransferRun', 333 supports_download=False, 334 ) 335 336 def List(self, request, global_params=None): 337 r"""Returns information about running and completed jobs. 338 339 Args: 340 request: (BigquerydatatransferProjectsLocationsTransferConfigsRunsListRequest) input message 341 global_params: (StandardQueryParameters, default: None) global arguments 342 Returns: 343 (ListTransferRunsResponse) The response message. 344 """ 345 config = self.GetMethodConfig('List') 346 return self._RunMethod( 347 config, request, global_params=global_params) 348 349 List.method_config = lambda: base_api.ApiMethodInfo( 350 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs', 351 http_method='GET', 352 method_id='bigquerydatatransfer.projects.locations.transferConfigs.runs.list', 353 ordered_params=['parent'], 354 path_params=['parent'], 355 query_params=['pageSize', 'pageToken', 'runAttempt', 'states'], 356 relative_path='v1/{+parent}/runs', 357 request_field='', 358 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsRunsListRequest', 359 response_type_name='ListTransferRunsResponse', 360 supports_download=False, 361 ) 362 363 class ProjectsLocationsTransferConfigsService(base_api.BaseApiService): 364 """Service class for the projects_locations_transferConfigs resource.""" 365 366 _NAME = 'projects_locations_transferConfigs' 367 368 def __init__(self, client): 369 super(BigquerydatatransferV1.ProjectsLocationsTransferConfigsService, self).__init__(client) 370 self._upload_configs = { 371 } 372 373 def Create(self, request, global_params=None): 374 r"""Creates a new data transfer configuration. 375 376 Args: 377 request: (BigquerydatatransferProjectsLocationsTransferConfigsCreateRequest) input message 378 global_params: (StandardQueryParameters, default: None) global arguments 379 Returns: 380 (TransferConfig) The response message. 381 """ 382 config = self.GetMethodConfig('Create') 383 return self._RunMethod( 384 config, request, global_params=global_params) 385 386 Create.method_config = lambda: base_api.ApiMethodInfo( 387 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs', 388 http_method='POST', 389 method_id='bigquerydatatransfer.projects.locations.transferConfigs.create', 390 ordered_params=['parent'], 391 path_params=['parent'], 392 query_params=['authorizationCode', 'serviceAccountName', 'versionInfo'], 393 relative_path='v1/{+parent}/transferConfigs', 394 request_field='transferConfig', 395 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsCreateRequest', 396 response_type_name='TransferConfig', 397 supports_download=False, 398 ) 399 400 def Delete(self, request, global_params=None): 401 r"""Deletes a data transfer configuration, including any associated transfer runs and logs. 402 403 Args: 404 request: (BigquerydatatransferProjectsLocationsTransferConfigsDeleteRequest) input message 405 global_params: (StandardQueryParameters, default: None) global arguments 406 Returns: 407 (Empty) The response message. 408 """ 409 config = self.GetMethodConfig('Delete') 410 return self._RunMethod( 411 config, request, global_params=global_params) 412 413 Delete.method_config = lambda: base_api.ApiMethodInfo( 414 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}', 415 http_method='DELETE', 416 method_id='bigquerydatatransfer.projects.locations.transferConfigs.delete', 417 ordered_params=['name'], 418 path_params=['name'], 419 query_params=[], 420 relative_path='v1/{+name}', 421 request_field='', 422 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsDeleteRequest', 423 response_type_name='Empty', 424 supports_download=False, 425 ) 426 427 def Get(self, request, global_params=None): 428 r"""Returns information about a data transfer config. 429 430 Args: 431 request: (BigquerydatatransferProjectsLocationsTransferConfigsGetRequest) input message 432 global_params: (StandardQueryParameters, default: None) global arguments 433 Returns: 434 (TransferConfig) The response message. 435 """ 436 config = self.GetMethodConfig('Get') 437 return self._RunMethod( 438 config, request, global_params=global_params) 439 440 Get.method_config = lambda: base_api.ApiMethodInfo( 441 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}', 442 http_method='GET', 443 method_id='bigquerydatatransfer.projects.locations.transferConfigs.get', 444 ordered_params=['name'], 445 path_params=['name'], 446 query_params=[], 447 relative_path='v1/{+name}', 448 request_field='', 449 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsGetRequest', 450 response_type_name='TransferConfig', 451 supports_download=False, 452 ) 453 454 def List(self, request, global_params=None): 455 r"""Returns information about all data transfers in the project. 456 457 Args: 458 request: (BigquerydatatransferProjectsLocationsTransferConfigsListRequest) input message 459 global_params: (StandardQueryParameters, default: None) global arguments 460 Returns: 461 (ListTransferConfigsResponse) The response message. 462 """ 463 config = self.GetMethodConfig('List') 464 return self._RunMethod( 465 config, request, global_params=global_params) 466 467 List.method_config = lambda: base_api.ApiMethodInfo( 468 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs', 469 http_method='GET', 470 method_id='bigquerydatatransfer.projects.locations.transferConfigs.list', 471 ordered_params=['parent'], 472 path_params=['parent'], 473 query_params=['dataSourceIds', 'pageSize', 'pageToken'], 474 relative_path='v1/{+parent}/transferConfigs', 475 request_field='', 476 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsListRequest', 477 response_type_name='ListTransferConfigsResponse', 478 supports_download=False, 479 ) 480 481 def Patch(self, request, global_params=None): 482 r"""Updates a data transfer configuration. All fields must be set, even if they are not updated. 483 484 Args: 485 request: (BigquerydatatransferProjectsLocationsTransferConfigsPatchRequest) input message 486 global_params: (StandardQueryParameters, default: None) global arguments 487 Returns: 488 (TransferConfig) The response message. 489 """ 490 config = self.GetMethodConfig('Patch') 491 return self._RunMethod( 492 config, request, global_params=global_params) 493 494 Patch.method_config = lambda: base_api.ApiMethodInfo( 495 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}', 496 http_method='PATCH', 497 method_id='bigquerydatatransfer.projects.locations.transferConfigs.patch', 498 ordered_params=['name'], 499 path_params=['name'], 500 query_params=['authorizationCode', 'serviceAccountName', 'updateMask', 'versionInfo'], 501 relative_path='v1/{+name}', 502 request_field='transferConfig', 503 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsPatchRequest', 504 response_type_name='TransferConfig', 505 supports_download=False, 506 ) 507 508 def ScheduleRuns(self, request, global_params=None): 509 r"""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. 510 511 Args: 512 request: (BigquerydatatransferProjectsLocationsTransferConfigsScheduleRunsRequest) input message 513 global_params: (StandardQueryParameters, default: None) global arguments 514 Returns: 515 (ScheduleTransferRunsResponse) The response message. 516 """ 517 config = self.GetMethodConfig('ScheduleRuns') 518 return self._RunMethod( 519 config, request, global_params=global_params) 520 521 ScheduleRuns.method_config = lambda: base_api.ApiMethodInfo( 522 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns', 523 http_method='POST', 524 method_id='bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns', 525 ordered_params=['parent'], 526 path_params=['parent'], 527 query_params=[], 528 relative_path='v1/{+parent}:scheduleRuns', 529 request_field='scheduleTransferRunsRequest', 530 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsScheduleRunsRequest', 531 response_type_name='ScheduleTransferRunsResponse', 532 supports_download=False, 533 ) 534 535 def StartManualRuns(self, request, global_params=None): 536 r"""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. 537 538 Args: 539 request: (BigquerydatatransferProjectsLocationsTransferConfigsStartManualRunsRequest) input message 540 global_params: (StandardQueryParameters, default: None) global arguments 541 Returns: 542 (StartManualTransferRunsResponse) The response message. 543 """ 544 config = self.GetMethodConfig('StartManualRuns') 545 return self._RunMethod( 546 config, request, global_params=global_params) 547 548 StartManualRuns.method_config = lambda: base_api.ApiMethodInfo( 549 flat_path='v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns', 550 http_method='POST', 551 method_id='bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns', 552 ordered_params=['parent'], 553 path_params=['parent'], 554 query_params=[], 555 relative_path='v1/{+parent}:startManualRuns', 556 request_field='startManualTransferRunsRequest', 557 request_type_name='BigquerydatatransferProjectsLocationsTransferConfigsStartManualRunsRequest', 558 response_type_name='StartManualTransferRunsResponse', 559 supports_download=False, 560 ) 561 562 class ProjectsLocationsService(base_api.BaseApiService): 563 """Service class for the projects_locations resource.""" 564 565 _NAME = 'projects_locations' 566 567 def __init__(self, client): 568 super(BigquerydatatransferV1.ProjectsLocationsService, self).__init__(client) 569 self._upload_configs = { 570 } 571 572 def Get(self, request, global_params=None): 573 r"""Gets information about a location. 574 575 Args: 576 request: (BigquerydatatransferProjectsLocationsGetRequest) input message 577 global_params: (StandardQueryParameters, default: None) global arguments 578 Returns: 579 (Location) The response message. 580 """ 581 config = self.GetMethodConfig('Get') 582 return self._RunMethod( 583 config, request, global_params=global_params) 584 585 Get.method_config = lambda: base_api.ApiMethodInfo( 586 flat_path='v1/projects/{projectsId}/locations/{locationsId}', 587 http_method='GET', 588 method_id='bigquerydatatransfer.projects.locations.get', 589 ordered_params=['name'], 590 path_params=['name'], 591 query_params=[], 592 relative_path='v1/{+name}', 593 request_field='', 594 request_type_name='BigquerydatatransferProjectsLocationsGetRequest', 595 response_type_name='Location', 596 supports_download=False, 597 ) 598 599 def List(self, request, global_params=None): 600 r"""Lists information about the supported locations for this service. 601 602 Args: 603 request: (BigquerydatatransferProjectsLocationsListRequest) input message 604 global_params: (StandardQueryParameters, default: None) global arguments 605 Returns: 606 (ListLocationsResponse) The response message. 607 """ 608 config = self.GetMethodConfig('List') 609 return self._RunMethod( 610 config, request, global_params=global_params) 611 612 List.method_config = lambda: base_api.ApiMethodInfo( 613 flat_path='v1/projects/{projectsId}/locations', 614 http_method='GET', 615 method_id='bigquerydatatransfer.projects.locations.list', 616 ordered_params=['name'], 617 path_params=['name'], 618 query_params=['filter', 'pageSize', 'pageToken'], 619 relative_path='v1/{+name}/locations', 620 request_field='', 621 request_type_name='BigquerydatatransferProjectsLocationsListRequest', 622 response_type_name='ListLocationsResponse', 623 supports_download=False, 624 ) 625 626 class ProjectsTransferConfigsRunsTransferLogsService(base_api.BaseApiService): 627 """Service class for the projects_transferConfigs_runs_transferLogs resource.""" 628 629 _NAME = 'projects_transferConfigs_runs_transferLogs' 630 631 def __init__(self, client): 632 super(BigquerydatatransferV1.ProjectsTransferConfigsRunsTransferLogsService, self).__init__(client) 633 self._upload_configs = { 634 } 635 636 def List(self, request, global_params=None): 637 r"""Returns user facing log messages for the data transfer run. 638 639 Args: 640 request: (BigquerydatatransferProjectsTransferConfigsRunsTransferLogsListRequest) input message 641 global_params: (StandardQueryParameters, default: None) global arguments 642 Returns: 643 (ListTransferLogsResponse) The response message. 644 """ 645 config = self.GetMethodConfig('List') 646 return self._RunMethod( 647 config, request, global_params=global_params) 648 649 List.method_config = lambda: base_api.ApiMethodInfo( 650 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs', 651 http_method='GET', 652 method_id='bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list', 653 ordered_params=['parent'], 654 path_params=['parent'], 655 query_params=['messageTypes', 'pageSize', 'pageToken'], 656 relative_path='v1/{+parent}/transferLogs', 657 request_field='', 658 request_type_name='BigquerydatatransferProjectsTransferConfigsRunsTransferLogsListRequest', 659 response_type_name='ListTransferLogsResponse', 660 supports_download=False, 661 ) 662 663 class ProjectsTransferConfigsRunsService(base_api.BaseApiService): 664 """Service class for the projects_transferConfigs_runs resource.""" 665 666 _NAME = 'projects_transferConfigs_runs' 667 668 def __init__(self, client): 669 super(BigquerydatatransferV1.ProjectsTransferConfigsRunsService, self).__init__(client) 670 self._upload_configs = { 671 } 672 673 def Delete(self, request, global_params=None): 674 r"""Deletes the specified transfer run. 675 676 Args: 677 request: (BigquerydatatransferProjectsTransferConfigsRunsDeleteRequest) input message 678 global_params: (StandardQueryParameters, default: None) global arguments 679 Returns: 680 (Empty) The response message. 681 """ 682 config = self.GetMethodConfig('Delete') 683 return self._RunMethod( 684 config, request, global_params=global_params) 685 686 Delete.method_config = lambda: base_api.ApiMethodInfo( 687 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}', 688 http_method='DELETE', 689 method_id='bigquerydatatransfer.projects.transferConfigs.runs.delete', 690 ordered_params=['name'], 691 path_params=['name'], 692 query_params=[], 693 relative_path='v1/{+name}', 694 request_field='', 695 request_type_name='BigquerydatatransferProjectsTransferConfigsRunsDeleteRequest', 696 response_type_name='Empty', 697 supports_download=False, 698 ) 699 700 def Get(self, request, global_params=None): 701 r"""Returns information about the particular transfer run. 702 703 Args: 704 request: (BigquerydatatransferProjectsTransferConfigsRunsGetRequest) input message 705 global_params: (StandardQueryParameters, default: None) global arguments 706 Returns: 707 (TransferRun) The response message. 708 """ 709 config = self.GetMethodConfig('Get') 710 return self._RunMethod( 711 config, request, global_params=global_params) 712 713 Get.method_config = lambda: base_api.ApiMethodInfo( 714 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}', 715 http_method='GET', 716 method_id='bigquerydatatransfer.projects.transferConfigs.runs.get', 717 ordered_params=['name'], 718 path_params=['name'], 719 query_params=[], 720 relative_path='v1/{+name}', 721 request_field='', 722 request_type_name='BigquerydatatransferProjectsTransferConfigsRunsGetRequest', 723 response_type_name='TransferRun', 724 supports_download=False, 725 ) 726 727 def List(self, request, global_params=None): 728 r"""Returns information about running and completed jobs. 729 730 Args: 731 request: (BigquerydatatransferProjectsTransferConfigsRunsListRequest) input message 732 global_params: (StandardQueryParameters, default: None) global arguments 733 Returns: 734 (ListTransferRunsResponse) The response message. 735 """ 736 config = self.GetMethodConfig('List') 737 return self._RunMethod( 738 config, request, global_params=global_params) 739 740 List.method_config = lambda: base_api.ApiMethodInfo( 741 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs', 742 http_method='GET', 743 method_id='bigquerydatatransfer.projects.transferConfigs.runs.list', 744 ordered_params=['parent'], 745 path_params=['parent'], 746 query_params=['pageSize', 'pageToken', 'runAttempt', 'states'], 747 relative_path='v1/{+parent}/runs', 748 request_field='', 749 request_type_name='BigquerydatatransferProjectsTransferConfigsRunsListRequest', 750 response_type_name='ListTransferRunsResponse', 751 supports_download=False, 752 ) 753 754 class ProjectsTransferConfigsService(base_api.BaseApiService): 755 """Service class for the projects_transferConfigs resource.""" 756 757 _NAME = 'projects_transferConfigs' 758 759 def __init__(self, client): 760 super(BigquerydatatransferV1.ProjectsTransferConfigsService, self).__init__(client) 761 self._upload_configs = { 762 } 763 764 def Create(self, request, global_params=None): 765 r"""Creates a new data transfer configuration. 766 767 Args: 768 request: (BigquerydatatransferProjectsTransferConfigsCreateRequest) input message 769 global_params: (StandardQueryParameters, default: None) global arguments 770 Returns: 771 (TransferConfig) The response message. 772 """ 773 config = self.GetMethodConfig('Create') 774 return self._RunMethod( 775 config, request, global_params=global_params) 776 777 Create.method_config = lambda: base_api.ApiMethodInfo( 778 flat_path='v1/projects/{projectsId}/transferConfigs', 779 http_method='POST', 780 method_id='bigquerydatatransfer.projects.transferConfigs.create', 781 ordered_params=['parent'], 782 path_params=['parent'], 783 query_params=['authorizationCode', 'serviceAccountName', 'versionInfo'], 784 relative_path='v1/{+parent}/transferConfigs', 785 request_field='transferConfig', 786 request_type_name='BigquerydatatransferProjectsTransferConfigsCreateRequest', 787 response_type_name='TransferConfig', 788 supports_download=False, 789 ) 790 791 def Delete(self, request, global_params=None): 792 r"""Deletes a data transfer configuration, including any associated transfer runs and logs. 793 794 Args: 795 request: (BigquerydatatransferProjectsTransferConfigsDeleteRequest) input message 796 global_params: (StandardQueryParameters, default: None) global arguments 797 Returns: 798 (Empty) The response message. 799 """ 800 config = self.GetMethodConfig('Delete') 801 return self._RunMethod( 802 config, request, global_params=global_params) 803 804 Delete.method_config = lambda: base_api.ApiMethodInfo( 805 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}', 806 http_method='DELETE', 807 method_id='bigquerydatatransfer.projects.transferConfigs.delete', 808 ordered_params=['name'], 809 path_params=['name'], 810 query_params=[], 811 relative_path='v1/{+name}', 812 request_field='', 813 request_type_name='BigquerydatatransferProjectsTransferConfigsDeleteRequest', 814 response_type_name='Empty', 815 supports_download=False, 816 ) 817 818 def Get(self, request, global_params=None): 819 r"""Returns information about a data transfer config. 820 821 Args: 822 request: (BigquerydatatransferProjectsTransferConfigsGetRequest) input message 823 global_params: (StandardQueryParameters, default: None) global arguments 824 Returns: 825 (TransferConfig) The response message. 826 """ 827 config = self.GetMethodConfig('Get') 828 return self._RunMethod( 829 config, request, global_params=global_params) 830 831 Get.method_config = lambda: base_api.ApiMethodInfo( 832 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}', 833 http_method='GET', 834 method_id='bigquerydatatransfer.projects.transferConfigs.get', 835 ordered_params=['name'], 836 path_params=['name'], 837 query_params=[], 838 relative_path='v1/{+name}', 839 request_field='', 840 request_type_name='BigquerydatatransferProjectsTransferConfigsGetRequest', 841 response_type_name='TransferConfig', 842 supports_download=False, 843 ) 844 845 def List(self, request, global_params=None): 846 r"""Returns information about all data transfers in the project. 847 848 Args: 849 request: (BigquerydatatransferProjectsTransferConfigsListRequest) input message 850 global_params: (StandardQueryParameters, default: None) global arguments 851 Returns: 852 (ListTransferConfigsResponse) The response message. 853 """ 854 config = self.GetMethodConfig('List') 855 return self._RunMethod( 856 config, request, global_params=global_params) 857 858 List.method_config = lambda: base_api.ApiMethodInfo( 859 flat_path='v1/projects/{projectsId}/transferConfigs', 860 http_method='GET', 861 method_id='bigquerydatatransfer.projects.transferConfigs.list', 862 ordered_params=['parent'], 863 path_params=['parent'], 864 query_params=['dataSourceIds', 'pageSize', 'pageToken'], 865 relative_path='v1/{+parent}/transferConfigs', 866 request_field='', 867 request_type_name='BigquerydatatransferProjectsTransferConfigsListRequest', 868 response_type_name='ListTransferConfigsResponse', 869 supports_download=False, 870 ) 871 872 def Patch(self, request, global_params=None): 873 r"""Updates a data transfer configuration. All fields must be set, even if they are not updated. 874 875 Args: 876 request: (BigquerydatatransferProjectsTransferConfigsPatchRequest) input message 877 global_params: (StandardQueryParameters, default: None) global arguments 878 Returns: 879 (TransferConfig) The response message. 880 """ 881 config = self.GetMethodConfig('Patch') 882 return self._RunMethod( 883 config, request, global_params=global_params) 884 885 Patch.method_config = lambda: base_api.ApiMethodInfo( 886 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}', 887 http_method='PATCH', 888 method_id='bigquerydatatransfer.projects.transferConfigs.patch', 889 ordered_params=['name'], 890 path_params=['name'], 891 query_params=['authorizationCode', 'serviceAccountName', 'updateMask', 'versionInfo'], 892 relative_path='v1/{+name}', 893 request_field='transferConfig', 894 request_type_name='BigquerydatatransferProjectsTransferConfigsPatchRequest', 895 response_type_name='TransferConfig', 896 supports_download=False, 897 ) 898 899 def ScheduleRuns(self, request, global_params=None): 900 r"""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. 901 902 Args: 903 request: (BigquerydatatransferProjectsTransferConfigsScheduleRunsRequest) input message 904 global_params: (StandardQueryParameters, default: None) global arguments 905 Returns: 906 (ScheduleTransferRunsResponse) The response message. 907 """ 908 config = self.GetMethodConfig('ScheduleRuns') 909 return self._RunMethod( 910 config, request, global_params=global_params) 911 912 ScheduleRuns.method_config = lambda: base_api.ApiMethodInfo( 913 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns', 914 http_method='POST', 915 method_id='bigquerydatatransfer.projects.transferConfigs.scheduleRuns', 916 ordered_params=['parent'], 917 path_params=['parent'], 918 query_params=[], 919 relative_path='v1/{+parent}:scheduleRuns', 920 request_field='scheduleTransferRunsRequest', 921 request_type_name='BigquerydatatransferProjectsTransferConfigsScheduleRunsRequest', 922 response_type_name='ScheduleTransferRunsResponse', 923 supports_download=False, 924 ) 925 926 def StartManualRuns(self, request, global_params=None): 927 r"""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. 928 929 Args: 930 request: (BigquerydatatransferProjectsTransferConfigsStartManualRunsRequest) input message 931 global_params: (StandardQueryParameters, default: None) global arguments 932 Returns: 933 (StartManualTransferRunsResponse) The response message. 934 """ 935 config = self.GetMethodConfig('StartManualRuns') 936 return self._RunMethod( 937 config, request, global_params=global_params) 938 939 StartManualRuns.method_config = lambda: base_api.ApiMethodInfo( 940 flat_path='v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns', 941 http_method='POST', 942 method_id='bigquerydatatransfer.projects.transferConfigs.startManualRuns', 943 ordered_params=['parent'], 944 path_params=['parent'], 945 query_params=[], 946 relative_path='v1/{+parent}:startManualRuns', 947 request_field='startManualTransferRunsRequest', 948 request_type_name='BigquerydatatransferProjectsTransferConfigsStartManualRunsRequest', 949 response_type_name='StartManualTransferRunsResponse', 950 supports_download=False, 951 ) 952 953 class ProjectsService(base_api.BaseApiService): 954 """Service class for the projects resource.""" 955 956 _NAME = 'projects' 957 958 def __init__(self, client): 959 super(BigquerydatatransferV1.ProjectsService, self).__init__(client) 960 self._upload_configs = { 961 } 962