@maxim_mazurok/gapi.client.bigquerydatatransfer-v1 0.1.20260310 → 0.1.20260601

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +409 -110
  2. package/package.json +1 -1
  3. package/readme.md +17 -0
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://bigquerydatatransfer.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20260310
12
+ // Revision: 20260601
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -33,13 +33,24 @@ declare namespace gapi.client {
33
33
  /** If set to `true`, the credentials exist and are valid. */
34
34
  hasValidCreds?: boolean;
35
35
  }
36
+ interface DataplexConfiguration {
37
+ /** Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. */
38
+ entryGroup?: string;
39
+ }
36
40
  interface DataSource {
37
41
  /** Indicates the type of authorization. */
38
- authorizationType?: string;
42
+ authorizationType?:
43
+ | 'AUTHORIZATION_TYPE_UNSPECIFIED'
44
+ | 'AUTHORIZATION_CODE'
45
+ | 'GOOGLE_PLUS_AUTHORIZATION_CODE'
46
+ | 'FIRST_PARTY_OAUTH';
39
47
  /** Data source client id which should be used to receive refresh token. */
40
48
  clientId?: string;
41
49
  /** 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. */
42
- dataRefreshType?: string;
50
+ dataRefreshType?:
51
+ | 'DATA_REFRESH_TYPE_UNSPECIFIED'
52
+ | 'SLIDING_WINDOW'
53
+ | 'CUSTOM_SLIDING_WINDOW';
43
54
  /** Data source id. */
44
55
  dataSourceId?: string;
45
56
  /** Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. */
@@ -67,7 +78,7 @@ declare namespace gapi.client {
67
78
  /** Deprecated. This field has no effect. */
68
79
  supportsMultipleTransfers?: boolean;
69
80
  /** Deprecated. This field has no effect. */
70
- transferType?: string;
81
+ transferType?: 'TRANSFER_TYPE_UNSPECIFIED' | 'BATCH' | 'STREAMING';
71
82
  /** The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. */
72
83
  updateDeadlineSeconds?: number;
73
84
  }
@@ -99,7 +110,15 @@ declare namespace gapi.client {
99
110
  /** Is parameter required. */
100
111
  required?: boolean;
101
112
  /** Parameter type. */
102
- type?: string;
113
+ type?:
114
+ | 'TYPE_UNSPECIFIED'
115
+ | 'STRING'
116
+ | 'INTEGER'
117
+ | 'DOUBLE'
118
+ | 'BOOLEAN'
119
+ | 'RECORD'
120
+ | 'PLUS_PAGE'
121
+ | 'LIST';
103
122
  /** Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values. */
104
123
  validationDescription?: string;
105
124
  /** URL to a help document to further explain the naming requirements. */
@@ -124,6 +143,12 @@ declare namespace gapi.client {
124
143
  /** Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription} */
125
144
  pubsubSubscription?: string;
126
145
  }
146
+ interface HierarchyDetail {
147
+ /** Optional. Partition details related to hierarchy. */
148
+ partitionDetail?: PartitionDetail;
149
+ /** Optional. Table details related to hierarchy. */
150
+ tableDetail?: TableDetail;
151
+ }
127
152
  interface ListDataSourcesResponse {
128
153
  /** List of supported data sources and their transfer settings. */
129
154
  dataSources?: DataSource[];
@@ -148,6 +173,12 @@ declare namespace gapi.client {
148
173
  /** Output only. The stored pipeline transfer messages. */
149
174
  transferMessages?: TransferMessage[];
150
175
  }
176
+ interface ListTransferResourcesResponse {
177
+ /** Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
178
+ nextPageToken?: string;
179
+ /** Output only. The transfer resources. */
180
+ transferResources?: TransferResource[];
181
+ }
151
182
  interface ListTransferRunsResponse {
152
183
  /** 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. */
153
184
  nextPageToken?: string;
@@ -167,6 +198,14 @@ declare namespace gapi.client {
167
198
  name?: string;
168
199
  }
169
200
  interface ManualSchedule {}
201
+ interface MetadataDestination {
202
+ /** The Dataplex Universal Catalog configuration. */
203
+ dataplexConfiguration?: DataplexConfiguration;
204
+ }
205
+ interface PartitionDetail {
206
+ /** Optional. Name of the table which has the partitions. */
207
+ table?: string;
208
+ }
170
209
  interface ScheduleOptions {
171
210
  /** 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. */
172
211
  disableAutoScheduling?: boolean;
@@ -207,10 +246,14 @@ declare namespace gapi.client {
207
246
  /** The status code, which should be an enum value of google.rpc.Code. */
208
247
  code?: number;
209
248
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
210
- details?: Array<{[P in string]: any}>;
249
+ details?: {[P in string]: any}[];
211
250
  /** 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. */
212
251
  message?: string;
213
252
  }
253
+ interface TableDetail {
254
+ /** Optional. Total number of partitions being tracked within the table. */
255
+ partitionCount?: string;
256
+ }
214
257
  interface TimeBasedSchedule {
215
258
  /** 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. */
216
259
  endTime?: string;
@@ -245,7 +288,12 @@ declare namespace gapi.client {
245
288
  /** Output only. Error code with detailed information about reason of the latest config failure. */
246
289
  error?: Status;
247
290
  /** The classification of the destination table. */
248
- managedTableType?: string;
291
+ managedTableType?:
292
+ | 'MANAGED_TABLE_TYPE_UNSPECIFIED'
293
+ | 'NATIVE'
294
+ | 'BIGLAKE';
295
+ /** The metadata destination of the transfer config. */
296
+ metadataDestination?: MetadataDestination;
249
297
  /** Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/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. */
250
298
  name?: string;
251
299
  /** Output only. Next time when data transfer will run. */
@@ -263,7 +311,13 @@ declare namespace gapi.client {
263
311
  /** Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule. */
264
312
  scheduleOptionsV2?: ScheduleOptionsV2;
265
313
  /** Output only. State of the most recently updated transfer run. */
266
- state?: string;
314
+ state?:
315
+ | 'TRANSFER_STATE_UNSPECIFIED'
316
+ | 'PENDING'
317
+ | 'RUNNING'
318
+ | 'SUCCEEDED'
319
+ | 'FAILED'
320
+ | 'CANCELLED';
267
321
  /** Output only. Data transfer modification time. Ignored by server on input. */
268
322
  updateTime?: string;
269
323
  /** Deprecated. Unique ID of the user on whose behalf transfer is done. */
@@ -275,7 +329,50 @@ declare namespace gapi.client {
275
329
  /** Time when message was logged. */
276
330
  messageTime?: string;
277
331
  /** Message severity. */
278
- severity?: string;
332
+ severity?: 'MESSAGE_SEVERITY_UNSPECIFIED' | 'INFO' | 'WARNING' | 'ERROR';
333
+ }
334
+ interface TransferResource {
335
+ /** Optional. Resource destination. */
336
+ destination?:
337
+ | 'RESOURCE_DESTINATION_UNSPECIFIED'
338
+ | 'RESOURCE_DESTINATION_BIGQUERY'
339
+ | 'RESOURCE_DESTINATION_DATAPROC_METASTORE'
340
+ | 'RESOURCE_DESTINATION_BIGLAKE_METASTORE'
341
+ | 'RESOURCE_DESTINATION_BIGLAKE_REST_CATALOG'
342
+ | 'RESOURCE_DESTINATION_BIGLAKE_HIVE_CATALOG';
343
+ /** Optional. Details about the hierarchy. */
344
+ hierarchyDetail?: HierarchyDetail;
345
+ /** Output only. Run details for the last successful run. */
346
+ lastSuccessfulRun?: TransferRunBrief;
347
+ /** Optional. Run details for the latest run. */
348
+ latestRun?: TransferRunBrief;
349
+ /** Optional. Status details for the latest run. */
350
+ latestStatusDetail?: TransferResourceStatusDetail;
351
+ /** Identifier. Resource name. */
352
+ name?: string;
353
+ /** Optional. Resource type. */
354
+ type?:
355
+ | 'RESOURCE_TYPE_UNSPECIFIED'
356
+ | 'RESOURCE_TYPE_TABLE'
357
+ | 'RESOURCE_TYPE_PARTITION';
358
+ /** Output only. Time when the resource was last updated. */
359
+ updateTime?: string;
360
+ }
361
+ interface TransferResourceStatusDetail {
362
+ /** Output only. Percentage of the transfer completed. Valid values: 0-100. */
363
+ completedPercentage?: number;
364
+ /** Optional. Transfer error details for the resource. */
365
+ error?: Status;
366
+ /** Optional. Transfer state of the resource. */
367
+ state?:
368
+ | 'RESOURCE_TRANSFER_STATE_UNSPECIFIED'
369
+ | 'RESOURCE_TRANSFER_PENDING'
370
+ | 'RESOURCE_TRANSFER_RUNNING'
371
+ | 'RESOURCE_TRANSFER_SUCCEEDED'
372
+ | 'RESOURCE_TRANSFER_FAILED'
373
+ | 'RESOURCE_TRANSFER_CANCELLED';
374
+ /** Optional. Transfer status summary of the resource. */
375
+ summary?: TransferStatusSummary;
279
376
  }
280
377
  interface TransferRun {
281
378
  /** Output only. Data source id. */
@@ -288,6 +385,8 @@ declare namespace gapi.client {
288
385
  endTime?: string;
289
386
  /** Status of the transfer run. */
290
387
  errorStatus?: Status;
388
+ /** Output only. The metadata destination of the transfer run. */
389
+ metadataDestination?: MetadataDestination;
291
390
  /** Identifier. 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. */
292
391
  name?: string;
293
392
  /** 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_id}/topics/{topic_id}` */
@@ -303,12 +402,48 @@ declare namespace gapi.client {
303
402
  /** Output only. Time when transfer run was started. Parameter ignored by server for input requests. */
304
403
  startTime?: string;
305
404
  /** Data transfer run state. Ignored for input requests. */
306
- state?: string;
405
+ state?:
406
+ | 'TRANSFER_STATE_UNSPECIFIED'
407
+ | 'PENDING'
408
+ | 'RUNNING'
409
+ | 'SUCCEEDED'
410
+ | 'FAILED'
411
+ | 'CANCELLED';
307
412
  /** Output only. Last time the data transfer run state was updated. */
308
413
  updateTime?: string;
309
414
  /** Deprecated. Unique ID of the user on whose behalf transfer is done. */
310
415
  userId?: string;
311
416
  }
417
+ interface TransferRunBrief {
418
+ /** Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` */
419
+ run?: string;
420
+ /** Optional. Start time of the transfer run. */
421
+ startTime?: string;
422
+ }
423
+ interface TransferStatusMetric {
424
+ /** Optional. Number of units transferred successfully. */
425
+ completed?: string;
426
+ /** Optional. Number of units that failed to transfer. */
427
+ failed?: string;
428
+ /** Optional. Number of units pending transfer. */
429
+ pending?: string;
430
+ /** Optional. Total number of units for the transfer. */
431
+ total?: string;
432
+ /** Optional. Unit for measuring progress (e.g., BYTES). */
433
+ unit?:
434
+ | 'TRANSFER_STATUS_UNIT_UNSPECIFIED'
435
+ | 'TRANSFER_STATUS_UNIT_BYTES'
436
+ | 'TRANSFER_STATUS_UNIT_OBJECTS';
437
+ }
438
+ interface TransferStatusSummary {
439
+ /** Optional. List of transfer status metrics. */
440
+ metrics?: TransferStatusMetric[];
441
+ /** Input only. Unit based on which transfer status progress should be calculated. */
442
+ progressUnit?:
443
+ | 'TRANSFER_STATUS_UNIT_UNSPECIFIED'
444
+ | 'TRANSFER_STATUS_UNIT_BYTES'
445
+ | 'TRANSFER_STATUS_UNIT_OBJECTS';
446
+ }
312
447
  interface UnenrollDataSourcesRequest {
313
448
  /** Data sources that are unenrolled. It is required to provide at least one data source id. */
314
449
  dataSourceIds?: string[];
@@ -321,11 +456,11 @@ declare namespace gapi.client {
321
456
  /** Returns true if valid credentials exist for the given data source and requesting user. */
322
457
  checkValidCreds(request: {
323
458
  /** V1 error format. */
324
- '$.xgafv'?: string;
459
+ '$.xgafv'?: '1' | '2';
325
460
  /** OAuth access token. */
326
461
  access_token?: string;
327
462
  /** Data format for response. */
328
- alt?: string;
463
+ alt?: 'json' | 'media' | 'proto';
329
464
  /** JSONP */
330
465
  callback?: string;
331
466
  /** Selector specifying which fields to include in a partial response. */
@@ -350,11 +485,11 @@ declare namespace gapi.client {
350
485
  checkValidCreds(
351
486
  request: {
352
487
  /** V1 error format. */
353
- '$.xgafv'?: string;
488
+ '$.xgafv'?: '1' | '2';
354
489
  /** OAuth access token. */
355
490
  access_token?: string;
356
491
  /** Data format for response. */
357
- alt?: string;
492
+ alt?: 'json' | 'media' | 'proto';
358
493
  /** JSONP */
359
494
  callback?: string;
360
495
  /** Selector specifying which fields to include in a partial response. */
@@ -379,11 +514,11 @@ declare namespace gapi.client {
379
514
  /** Retrieves a supported data source and returns its settings. */
380
515
  get(request?: {
381
516
  /** V1 error format. */
382
- '$.xgafv'?: string;
517
+ '$.xgafv'?: '1' | '2';
383
518
  /** OAuth access token. */
384
519
  access_token?: string;
385
520
  /** Data format for response. */
386
- alt?: string;
521
+ alt?: 'json' | 'media' | 'proto';
387
522
  /** JSONP */
388
523
  callback?: string;
389
524
  /** Selector specifying which fields to include in a partial response. */
@@ -406,11 +541,11 @@ declare namespace gapi.client {
406
541
  /** Lists supported data sources and returns their settings. */
407
542
  list(request?: {
408
543
  /** V1 error format. */
409
- '$.xgafv'?: string;
544
+ '$.xgafv'?: '1' | '2';
410
545
  /** OAuth access token. */
411
546
  access_token?: string;
412
547
  /** Data format for response. */
413
- alt?: string;
548
+ alt?: 'json' | 'media' | 'proto';
414
549
  /** JSONP */
415
550
  callback?: string;
416
551
  /** Selector specifying which fields to include in a partial response. */
@@ -439,11 +574,11 @@ declare namespace gapi.client {
439
574
  /** Returns true if valid credentials exist for the given data source and requesting user. */
440
575
  checkValidCreds(request: {
441
576
  /** V1 error format. */
442
- '$.xgafv'?: string;
577
+ '$.xgafv'?: '1' | '2';
443
578
  /** OAuth access token. */
444
579
  access_token?: string;
445
580
  /** Data format for response. */
446
- alt?: string;
581
+ alt?: 'json' | 'media' | 'proto';
447
582
  /** JSONP */
448
583
  callback?: string;
449
584
  /** Selector specifying which fields to include in a partial response. */
@@ -468,11 +603,11 @@ declare namespace gapi.client {
468
603
  checkValidCreds(
469
604
  request: {
470
605
  /** V1 error format. */
471
- '$.xgafv'?: string;
606
+ '$.xgafv'?: '1' | '2';
472
607
  /** OAuth access token. */
473
608
  access_token?: string;
474
609
  /** Data format for response. */
475
- alt?: string;
610
+ alt?: 'json' | 'media' | 'proto';
476
611
  /** JSONP */
477
612
  callback?: string;
478
613
  /** Selector specifying which fields to include in a partial response. */
@@ -497,11 +632,11 @@ declare namespace gapi.client {
497
632
  /** Retrieves a supported data source and returns its settings. */
498
633
  get(request?: {
499
634
  /** V1 error format. */
500
- '$.xgafv'?: string;
635
+ '$.xgafv'?: '1' | '2';
501
636
  /** OAuth access token. */
502
637
  access_token?: string;
503
638
  /** Data format for response. */
504
- alt?: string;
639
+ alt?: 'json' | 'media' | 'proto';
505
640
  /** JSONP */
506
641
  callback?: string;
507
642
  /** Selector specifying which fields to include in a partial response. */
@@ -524,11 +659,11 @@ declare namespace gapi.client {
524
659
  /** Lists supported data sources and returns their settings. */
525
660
  list(request?: {
526
661
  /** V1 error format. */
527
- '$.xgafv'?: string;
662
+ '$.xgafv'?: '1' | '2';
528
663
  /** OAuth access token. */
529
664
  access_token?: string;
530
665
  /** Data format for response. */
531
- alt?: string;
666
+ alt?: 'json' | 'media' | 'proto';
532
667
  /** JSONP */
533
668
  callback?: string;
534
669
  /** Selector specifying which fields to include in a partial response. */
@@ -557,11 +692,11 @@ declare namespace gapi.client {
557
692
  /** Returns log messages for the transfer run. */
558
693
  list(request?: {
559
694
  /** V1 error format. */
560
- '$.xgafv'?: string;
695
+ '$.xgafv'?: '1' | '2';
561
696
  /** OAuth access token. */
562
697
  access_token?: string;
563
698
  /** Data format for response. */
564
- alt?: string;
699
+ alt?: 'json' | 'media' | 'proto';
565
700
  /** JSONP */
566
701
  callback?: string;
567
702
  /** Selector specifying which fields to include in a partial response. */
@@ -569,7 +704,12 @@ declare namespace gapi.client {
569
704
  /** 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. */
570
705
  key?: string;
571
706
  /** Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. */
572
- messageTypes?: string | string[];
707
+ messageTypes?:
708
+ | 'MESSAGE_SEVERITY_UNSPECIFIED'
709
+ | 'INFO'
710
+ | 'WARNING'
711
+ | 'ERROR'
712
+ | ('MESSAGE_SEVERITY_UNSPECIFIED' | 'INFO' | 'WARNING' | 'ERROR')[];
573
713
  /** OAuth 2.0 token for the current user. */
574
714
  oauth_token?: string;
575
715
  /** Page size. The default page size is the maximum value of 1000 results. */
@@ -592,11 +732,11 @@ declare namespace gapi.client {
592
732
  /** Deletes the specified transfer run. */
593
733
  delete(request?: {
594
734
  /** V1 error format. */
595
- '$.xgafv'?: string;
735
+ '$.xgafv'?: '1' | '2';
596
736
  /** OAuth access token. */
597
737
  access_token?: string;
598
738
  /** Data format for response. */
599
- alt?: string;
739
+ alt?: 'json' | 'media' | 'proto';
600
740
  /** JSONP */
601
741
  callback?: string;
602
742
  /** Selector specifying which fields to include in a partial response. */
@@ -619,11 +759,11 @@ declare namespace gapi.client {
619
759
  /** Returns information about the particular transfer run. */
620
760
  get(request?: {
621
761
  /** V1 error format. */
622
- '$.xgafv'?: string;
762
+ '$.xgafv'?: '1' | '2';
623
763
  /** OAuth access token. */
624
764
  access_token?: string;
625
765
  /** Data format for response. */
626
- alt?: string;
766
+ alt?: 'json' | 'media' | 'proto';
627
767
  /** JSONP */
628
768
  callback?: string;
629
769
  /** Selector specifying which fields to include in a partial response. */
@@ -646,11 +786,11 @@ declare namespace gapi.client {
646
786
  /** Returns information about running and completed transfer runs. */
647
787
  list(request?: {
648
788
  /** V1 error format. */
649
- '$.xgafv'?: string;
789
+ '$.xgafv'?: '1' | '2';
650
790
  /** OAuth access token. */
651
791
  access_token?: string;
652
792
  /** Data format for response. */
653
- alt?: string;
793
+ alt?: 'json' | 'media' | 'proto';
654
794
  /** JSONP */
655
795
  callback?: string;
656
796
  /** Selector specifying which fields to include in a partial response. */
@@ -670,9 +810,23 @@ declare namespace gapi.client {
670
810
  /** 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. */
671
811
  quotaUser?: string;
672
812
  /** Indicates how run attempts are to be pulled. */
673
- runAttempt?: string;
813
+ runAttempt?: 'RUN_ATTEMPT_UNSPECIFIED' | 'LATEST';
674
814
  /** When specified, only transfer runs with requested states are returned. */
675
- states?: string | string[];
815
+ states?:
816
+ | 'TRANSFER_STATE_UNSPECIFIED'
817
+ | 'PENDING'
818
+ | 'RUNNING'
819
+ | 'SUCCEEDED'
820
+ | 'FAILED'
821
+ | 'CANCELLED'
822
+ | (
823
+ | 'TRANSFER_STATE_UNSPECIFIED'
824
+ | 'PENDING'
825
+ | 'RUNNING'
826
+ | 'SUCCEEDED'
827
+ | 'FAILED'
828
+ | 'CANCELLED'
829
+ )[];
676
830
  /** Upload protocol for media (e.g. "raw", "multipart"). */
677
831
  upload_protocol?: string;
678
832
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -680,15 +834,77 @@ declare namespace gapi.client {
680
834
  }): Request<ListTransferRunsResponse>;
681
835
  transferLogs: TransferLogsResource;
682
836
  }
837
+ interface TransferResourcesResource {
838
+ /** Returns a transfer resource. */
839
+ get(request?: {
840
+ /** V1 error format. */
841
+ '$.xgafv'?: '1' | '2';
842
+ /** OAuth access token. */
843
+ access_token?: string;
844
+ /** Data format for response. */
845
+ alt?: 'json' | 'media' | 'proto';
846
+ /** JSONP */
847
+ callback?: string;
848
+ /** Selector specifying which fields to include in a partial response. */
849
+ fields?: string;
850
+ /** 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. */
851
+ key?: string;
852
+ /** Required. The name of the transfer resource in the form of: * `projects/{project}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` * `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` */
853
+ name: string;
854
+ /** OAuth 2.0 token for the current user. */
855
+ oauth_token?: string;
856
+ /** Returns response with indentations and line breaks. */
857
+ prettyPrint?: boolean;
858
+ /** 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. */
859
+ quotaUser?: string;
860
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
861
+ upload_protocol?: string;
862
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
863
+ uploadType?: string;
864
+ }): Request<TransferResource>;
865
+ /** Returns information about transfer resources. */
866
+ list(request?: {
867
+ /** V1 error format. */
868
+ '$.xgafv'?: '1' | '2';
869
+ /** OAuth access token. */
870
+ access_token?: string;
871
+ /** Data format for response. */
872
+ alt?: 'json' | 'media' | 'proto';
873
+ /** JSONP */
874
+ callback?: string;
875
+ /** Selector specifying which fields to include in a partial response. */
876
+ fields?: string;
877
+ /** Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00"` * `hierarchy_detail.partition_detail.table = "table1"` */
878
+ filter?: string;
879
+ /** 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. */
880
+ key?: string;
881
+ /** OAuth 2.0 token for the current user. */
882
+ oauth_token?: string;
883
+ /** Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results. */
884
+ pageSize?: number;
885
+ /** Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` must match the call that provided the page token. */
886
+ pageToken?: string;
887
+ /** Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following forms: * `projects/{project}/transferConfigs/{transfer_config}` * `projects/{project}/locations/{location_id}/transferConfigs/{transfer_config}` */
888
+ parent: string;
889
+ /** Returns response with indentations and line breaks. */
890
+ prettyPrint?: boolean;
891
+ /** 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. */
892
+ quotaUser?: string;
893
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
894
+ upload_protocol?: string;
895
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
896
+ uploadType?: string;
897
+ }): Request<ListTransferResourcesResponse>;
898
+ }
683
899
  interface TransferConfigsResource {
684
900
  /** Creates a new data transfer configuration. */
685
901
  create(request: {
686
902
  /** V1 error format. */
687
- '$.xgafv'?: string;
903
+ '$.xgafv'?: '1' | '2';
688
904
  /** OAuth access token. */
689
905
  access_token?: string;
690
906
  /** Data format for response. */
691
- alt?: string;
907
+ alt?: 'json' | 'media' | 'proto';
692
908
  /** Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. */
693
909
  authorizationCode?: string;
694
910
  /** JSONP */
@@ -719,11 +935,11 @@ declare namespace gapi.client {
719
935
  create(
720
936
  request: {
721
937
  /** V1 error format. */
722
- '$.xgafv'?: string;
938
+ '$.xgafv'?: '1' | '2';
723
939
  /** OAuth access token. */
724
940
  access_token?: string;
725
941
  /** Data format for response. */
726
- alt?: string;
942
+ alt?: 'json' | 'media' | 'proto';
727
943
  /** Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. */
728
944
  authorizationCode?: string;
729
945
  /** JSONP */
@@ -754,11 +970,11 @@ declare namespace gapi.client {
754
970
  /** Deletes a data transfer configuration, including any associated transfer runs and logs. */
755
971
  delete(request?: {
756
972
  /** V1 error format. */
757
- '$.xgafv'?: string;
973
+ '$.xgafv'?: '1' | '2';
758
974
  /** OAuth access token. */
759
975
  access_token?: string;
760
976
  /** Data format for response. */
761
- alt?: string;
977
+ alt?: 'json' | 'media' | 'proto';
762
978
  /** JSONP */
763
979
  callback?: string;
764
980
  /** Selector specifying which fields to include in a partial response. */
@@ -781,11 +997,11 @@ declare namespace gapi.client {
781
997
  /** Returns information about a data transfer config. */
782
998
  get(request?: {
783
999
  /** V1 error format. */
784
- '$.xgafv'?: string;
1000
+ '$.xgafv'?: '1' | '2';
785
1001
  /** OAuth access token. */
786
1002
  access_token?: string;
787
1003
  /** Data format for response. */
788
- alt?: string;
1004
+ alt?: 'json' | 'media' | 'proto';
789
1005
  /** JSONP */
790
1006
  callback?: string;
791
1007
  /** Selector specifying which fields to include in a partial response. */
@@ -808,11 +1024,11 @@ declare namespace gapi.client {
808
1024
  /** Returns information about all transfer configs owned by a project in the specified location. */
809
1025
  list(request?: {
810
1026
  /** V1 error format. */
811
- '$.xgafv'?: string;
1027
+ '$.xgafv'?: '1' | '2';
812
1028
  /** OAuth access token. */
813
1029
  access_token?: string;
814
1030
  /** Data format for response. */
815
- alt?: string;
1031
+ alt?: 'json' | 'media' | 'proto';
816
1032
  /** JSONP */
817
1033
  callback?: string;
818
1034
  /** When specified, only configurations of requested data sources are returned. */
@@ -841,11 +1057,11 @@ declare namespace gapi.client {
841
1057
  /** Updates a data transfer configuration. All fields must be set, even if they are not updated. */
842
1058
  patch(request: {
843
1059
  /** V1 error format. */
844
- '$.xgafv'?: string;
1060
+ '$.xgafv'?: '1' | '2';
845
1061
  /** OAuth access token. */
846
1062
  access_token?: string;
847
1063
  /** Data format for response. */
848
- alt?: string;
1064
+ alt?: 'json' | 'media' | 'proto';
849
1065
  /** Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. */
850
1066
  authorizationCode?: string;
851
1067
  /** JSONP */
@@ -878,11 +1094,11 @@ declare namespace gapi.client {
878
1094
  patch(
879
1095
  request: {
880
1096
  /** V1 error format. */
881
- '$.xgafv'?: string;
1097
+ '$.xgafv'?: '1' | '2';
882
1098
  /** OAuth access token. */
883
1099
  access_token?: string;
884
1100
  /** Data format for response. */
885
- alt?: string;
1101
+ alt?: 'json' | 'media' | 'proto';
886
1102
  /** Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. */
887
1103
  authorizationCode?: string;
888
1104
  /** JSONP */
@@ -915,11 +1131,11 @@ declare namespace gapi.client {
915
1131
  /** 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. */
916
1132
  scheduleRuns(request: {
917
1133
  /** V1 error format. */
918
- '$.xgafv'?: string;
1134
+ '$.xgafv'?: '1' | '2';
919
1135
  /** OAuth access token. */
920
1136
  access_token?: string;
921
1137
  /** Data format for response. */
922
- alt?: string;
1138
+ alt?: 'json' | 'media' | 'proto';
923
1139
  /** JSONP */
924
1140
  callback?: string;
925
1141
  /** Selector specifying which fields to include in a partial response. */
@@ -944,11 +1160,11 @@ declare namespace gapi.client {
944
1160
  scheduleRuns(
945
1161
  request: {
946
1162
  /** V1 error format. */
947
- '$.xgafv'?: string;
1163
+ '$.xgafv'?: '1' | '2';
948
1164
  /** OAuth access token. */
949
1165
  access_token?: string;
950
1166
  /** Data format for response. */
951
- alt?: string;
1167
+ alt?: 'json' | 'media' | 'proto';
952
1168
  /** JSONP */
953
1169
  callback?: string;
954
1170
  /** Selector specifying which fields to include in a partial response. */
@@ -973,11 +1189,11 @@ declare namespace gapi.client {
973
1189
  /** Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each. */
974
1190
  startManualRuns(request: {
975
1191
  /** V1 error format. */
976
- '$.xgafv'?: string;
1192
+ '$.xgafv'?: '1' | '2';
977
1193
  /** OAuth access token. */
978
1194
  access_token?: string;
979
1195
  /** Data format for response. */
980
- alt?: string;
1196
+ alt?: 'json' | 'media' | 'proto';
981
1197
  /** JSONP */
982
1198
  callback?: string;
983
1199
  /** Selector specifying which fields to include in a partial response. */
@@ -1002,11 +1218,11 @@ declare namespace gapi.client {
1002
1218
  startManualRuns(
1003
1219
  request: {
1004
1220
  /** V1 error format. */
1005
- '$.xgafv'?: string;
1221
+ '$.xgafv'?: '1' | '2';
1006
1222
  /** OAuth access token. */
1007
1223
  access_token?: string;
1008
1224
  /** Data format for response. */
1009
- alt?: string;
1225
+ alt?: 'json' | 'media' | 'proto';
1010
1226
  /** JSONP */
1011
1227
  callback?: string;
1012
1228
  /** Selector specifying which fields to include in a partial response. */
@@ -1029,16 +1245,17 @@ declare namespace gapi.client {
1029
1245
  body: StartManualTransferRunsRequest,
1030
1246
  ): Request<StartManualTransferRunsResponse>;
1031
1247
  runs: RunsResource;
1248
+ transferResources: TransferResourcesResource;
1032
1249
  }
1033
1250
  interface LocationsResource {
1034
1251
  /** 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://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers). */
1035
1252
  enrollDataSources(request: {
1036
1253
  /** V1 error format. */
1037
- '$.xgafv'?: string;
1254
+ '$.xgafv'?: '1' | '2';
1038
1255
  /** OAuth access token. */
1039
1256
  access_token?: string;
1040
1257
  /** Data format for response. */
1041
- alt?: string;
1258
+ alt?: 'json' | 'media' | 'proto';
1042
1259
  /** JSONP */
1043
1260
  callback?: string;
1044
1261
  /** Selector specifying which fields to include in a partial response. */
@@ -1063,11 +1280,11 @@ declare namespace gapi.client {
1063
1280
  enrollDataSources(
1064
1281
  request: {
1065
1282
  /** V1 error format. */
1066
- '$.xgafv'?: string;
1283
+ '$.xgafv'?: '1' | '2';
1067
1284
  /** OAuth access token. */
1068
1285
  access_token?: string;
1069
1286
  /** Data format for response. */
1070
- alt?: string;
1287
+ alt?: 'json' | 'media' | 'proto';
1071
1288
  /** JSONP */
1072
1289
  callback?: string;
1073
1290
  /** Selector specifying which fields to include in a partial response. */
@@ -1092,11 +1309,11 @@ declare namespace gapi.client {
1092
1309
  /** Gets information about a location. */
1093
1310
  get(request?: {
1094
1311
  /** V1 error format. */
1095
- '$.xgafv'?: string;
1312
+ '$.xgafv'?: '1' | '2';
1096
1313
  /** OAuth access token. */
1097
1314
  access_token?: string;
1098
1315
  /** Data format for response. */
1099
- alt?: string;
1316
+ alt?: 'json' | 'media' | 'proto';
1100
1317
  /** JSONP */
1101
1318
  callback?: string;
1102
1319
  /** Selector specifying which fields to include in a partial response. */
@@ -1116,17 +1333,17 @@ declare namespace gapi.client {
1116
1333
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1117
1334
  uploadType?: string;
1118
1335
  }): Request<Location>;
1119
- /** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
1336
+ /** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
1120
1337
  list(request?: {
1121
1338
  /** V1 error format. */
1122
- '$.xgafv'?: string;
1339
+ '$.xgafv'?: '1' | '2';
1123
1340
  /** OAuth access token. */
1124
1341
  access_token?: string;
1125
1342
  /** Data format for response. */
1126
- alt?: string;
1343
+ alt?: 'json' | 'media' | 'proto';
1127
1344
  /** JSONP */
1128
1345
  callback?: string;
1129
- /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
1346
+ /** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
1130
1347
  extraLocationTypes?: string | string[];
1131
1348
  /** Selector specifying which fields to include in a partial response. */
1132
1349
  fields?: string;
@@ -1154,11 +1371,11 @@ declare namespace gapi.client {
1154
1371
  /** Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the [BigQuery UI](https://console.cloud.google.com/bigquery). Data transfers configurations of unenrolled data sources will not be scheduled. */
1155
1372
  unenrollDataSources(request: {
1156
1373
  /** V1 error format. */
1157
- '$.xgafv'?: string;
1374
+ '$.xgafv'?: '1' | '2';
1158
1375
  /** OAuth access token. */
1159
1376
  access_token?: string;
1160
1377
  /** Data format for response. */
1161
- alt?: string;
1378
+ alt?: 'json' | 'media' | 'proto';
1162
1379
  /** JSONP */
1163
1380
  callback?: string;
1164
1381
  /** Selector specifying which fields to include in a partial response. */
@@ -1183,11 +1400,11 @@ declare namespace gapi.client {
1183
1400
  unenrollDataSources(
1184
1401
  request: {
1185
1402
  /** V1 error format. */
1186
- '$.xgafv'?: string;
1403
+ '$.xgafv'?: '1' | '2';
1187
1404
  /** OAuth access token. */
1188
1405
  access_token?: string;
1189
1406
  /** Data format for response. */
1190
- alt?: string;
1407
+ alt?: 'json' | 'media' | 'proto';
1191
1408
  /** JSONP */
1192
1409
  callback?: string;
1193
1410
  /** Selector specifying which fields to include in a partial response. */
@@ -1216,11 +1433,11 @@ declare namespace gapi.client {
1216
1433
  /** Returns log messages for the transfer run. */
1217
1434
  list(request?: {
1218
1435
  /** V1 error format. */
1219
- '$.xgafv'?: string;
1436
+ '$.xgafv'?: '1' | '2';
1220
1437
  /** OAuth access token. */
1221
1438
  access_token?: string;
1222
1439
  /** Data format for response. */
1223
- alt?: string;
1440
+ alt?: 'json' | 'media' | 'proto';
1224
1441
  /** JSONP */
1225
1442
  callback?: string;
1226
1443
  /** Selector specifying which fields to include in a partial response. */
@@ -1228,7 +1445,12 @@ declare namespace gapi.client {
1228
1445
  /** 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. */
1229
1446
  key?: string;
1230
1447
  /** Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. */
1231
- messageTypes?: string | string[];
1448
+ messageTypes?:
1449
+ | 'MESSAGE_SEVERITY_UNSPECIFIED'
1450
+ | 'INFO'
1451
+ | 'WARNING'
1452
+ | 'ERROR'
1453
+ | ('MESSAGE_SEVERITY_UNSPECIFIED' | 'INFO' | 'WARNING' | 'ERROR')[];
1232
1454
  /** OAuth 2.0 token for the current user. */
1233
1455
  oauth_token?: string;
1234
1456
  /** Page size. The default page size is the maximum value of 1000 results. */
@@ -1251,11 +1473,11 @@ declare namespace gapi.client {
1251
1473
  /** Deletes the specified transfer run. */
1252
1474
  delete(request?: {
1253
1475
  /** V1 error format. */
1254
- '$.xgafv'?: string;
1476
+ '$.xgafv'?: '1' | '2';
1255
1477
  /** OAuth access token. */
1256
1478
  access_token?: string;
1257
1479
  /** Data format for response. */
1258
- alt?: string;
1480
+ alt?: 'json' | 'media' | 'proto';
1259
1481
  /** JSONP */
1260
1482
  callback?: string;
1261
1483
  /** Selector specifying which fields to include in a partial response. */
@@ -1278,11 +1500,11 @@ declare namespace gapi.client {
1278
1500
  /** Returns information about the particular transfer run. */
1279
1501
  get(request?: {
1280
1502
  /** V1 error format. */
1281
- '$.xgafv'?: string;
1503
+ '$.xgafv'?: '1' | '2';
1282
1504
  /** OAuth access token. */
1283
1505
  access_token?: string;
1284
1506
  /** Data format for response. */
1285
- alt?: string;
1507
+ alt?: 'json' | 'media' | 'proto';
1286
1508
  /** JSONP */
1287
1509
  callback?: string;
1288
1510
  /** Selector specifying which fields to include in a partial response. */
@@ -1305,11 +1527,11 @@ declare namespace gapi.client {
1305
1527
  /** Returns information about running and completed transfer runs. */
1306
1528
  list(request?: {
1307
1529
  /** V1 error format. */
1308
- '$.xgafv'?: string;
1530
+ '$.xgafv'?: '1' | '2';
1309
1531
  /** OAuth access token. */
1310
1532
  access_token?: string;
1311
1533
  /** Data format for response. */
1312
- alt?: string;
1534
+ alt?: 'json' | 'media' | 'proto';
1313
1535
  /** JSONP */
1314
1536
  callback?: string;
1315
1537
  /** Selector specifying which fields to include in a partial response. */
@@ -1329,9 +1551,23 @@ declare namespace gapi.client {
1329
1551
  /** 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. */
1330
1552
  quotaUser?: string;
1331
1553
  /** Indicates how run attempts are to be pulled. */
1332
- runAttempt?: string;
1554
+ runAttempt?: 'RUN_ATTEMPT_UNSPECIFIED' | 'LATEST';
1333
1555
  /** When specified, only transfer runs with requested states are returned. */
1334
- states?: string | string[];
1556
+ states?:
1557
+ | 'TRANSFER_STATE_UNSPECIFIED'
1558
+ | 'PENDING'
1559
+ | 'RUNNING'
1560
+ | 'SUCCEEDED'
1561
+ | 'FAILED'
1562
+ | 'CANCELLED'
1563
+ | (
1564
+ | 'TRANSFER_STATE_UNSPECIFIED'
1565
+ | 'PENDING'
1566
+ | 'RUNNING'
1567
+ | 'SUCCEEDED'
1568
+ | 'FAILED'
1569
+ | 'CANCELLED'
1570
+ )[];
1335
1571
  /** Upload protocol for media (e.g. "raw", "multipart"). */
1336
1572
  upload_protocol?: string;
1337
1573
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -1339,15 +1575,77 @@ declare namespace gapi.client {
1339
1575
  }): Request<ListTransferRunsResponse>;
1340
1576
  transferLogs: TransferLogsResource;
1341
1577
  }
1578
+ interface TransferResourcesResource {
1579
+ /** Returns a transfer resource. */
1580
+ get(request?: {
1581
+ /** V1 error format. */
1582
+ '$.xgafv'?: '1' | '2';
1583
+ /** OAuth access token. */
1584
+ access_token?: string;
1585
+ /** Data format for response. */
1586
+ alt?: 'json' | 'media' | 'proto';
1587
+ /** JSONP */
1588
+ callback?: string;
1589
+ /** Selector specifying which fields to include in a partial response. */
1590
+ fields?: string;
1591
+ /** 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. */
1592
+ key?: string;
1593
+ /** Required. The name of the transfer resource in the form of: * `projects/{project}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` * `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` */
1594
+ name: string;
1595
+ /** OAuth 2.0 token for the current user. */
1596
+ oauth_token?: string;
1597
+ /** Returns response with indentations and line breaks. */
1598
+ prettyPrint?: boolean;
1599
+ /** 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. */
1600
+ quotaUser?: string;
1601
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1602
+ upload_protocol?: string;
1603
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1604
+ uploadType?: string;
1605
+ }): Request<TransferResource>;
1606
+ /** Returns information about transfer resources. */
1607
+ list(request?: {
1608
+ /** V1 error format. */
1609
+ '$.xgafv'?: '1' | '2';
1610
+ /** OAuth access token. */
1611
+ access_token?: string;
1612
+ /** Data format for response. */
1613
+ alt?: 'json' | 'media' | 'proto';
1614
+ /** JSONP */
1615
+ callback?: string;
1616
+ /** Selector specifying which fields to include in a partial response. */
1617
+ fields?: string;
1618
+ /** Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00"` * `hierarchy_detail.partition_detail.table = "table1"` */
1619
+ filter?: string;
1620
+ /** 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. */
1621
+ key?: string;
1622
+ /** OAuth 2.0 token for the current user. */
1623
+ oauth_token?: string;
1624
+ /** Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results. */
1625
+ pageSize?: number;
1626
+ /** Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` must match the call that provided the page token. */
1627
+ pageToken?: string;
1628
+ /** Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following forms: * `projects/{project}/transferConfigs/{transfer_config}` * `projects/{project}/locations/{location_id}/transferConfigs/{transfer_config}` */
1629
+ parent: string;
1630
+ /** Returns response with indentations and line breaks. */
1631
+ prettyPrint?: boolean;
1632
+ /** 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. */
1633
+ quotaUser?: string;
1634
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1635
+ upload_protocol?: string;
1636
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1637
+ uploadType?: string;
1638
+ }): Request<ListTransferResourcesResponse>;
1639
+ }
1342
1640
  interface TransferConfigsResource {
1343
1641
  /** Creates a new data transfer configuration. */
1344
1642
  create(request: {
1345
1643
  /** V1 error format. */
1346
- '$.xgafv'?: string;
1644
+ '$.xgafv'?: '1' | '2';
1347
1645
  /** OAuth access token. */
1348
1646
  access_token?: string;
1349
1647
  /** Data format for response. */
1350
- alt?: string;
1648
+ alt?: 'json' | 'media' | 'proto';
1351
1649
  /** Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. */
1352
1650
  authorizationCode?: string;
1353
1651
  /** JSONP */
@@ -1378,11 +1676,11 @@ declare namespace gapi.client {
1378
1676
  create(
1379
1677
  request: {
1380
1678
  /** V1 error format. */
1381
- '$.xgafv'?: string;
1679
+ '$.xgafv'?: '1' | '2';
1382
1680
  /** OAuth access token. */
1383
1681
  access_token?: string;
1384
1682
  /** Data format for response. */
1385
- alt?: string;
1683
+ alt?: 'json' | 'media' | 'proto';
1386
1684
  /** Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. */
1387
1685
  authorizationCode?: string;
1388
1686
  /** JSONP */
@@ -1413,11 +1711,11 @@ declare namespace gapi.client {
1413
1711
  /** Deletes a data transfer configuration, including any associated transfer runs and logs. */
1414
1712
  delete(request?: {
1415
1713
  /** V1 error format. */
1416
- '$.xgafv'?: string;
1714
+ '$.xgafv'?: '1' | '2';
1417
1715
  /** OAuth access token. */
1418
1716
  access_token?: string;
1419
1717
  /** Data format for response. */
1420
- alt?: string;
1718
+ alt?: 'json' | 'media' | 'proto';
1421
1719
  /** JSONP */
1422
1720
  callback?: string;
1423
1721
  /** Selector specifying which fields to include in a partial response. */
@@ -1440,11 +1738,11 @@ declare namespace gapi.client {
1440
1738
  /** Returns information about a data transfer config. */
1441
1739
  get(request?: {
1442
1740
  /** V1 error format. */
1443
- '$.xgafv'?: string;
1741
+ '$.xgafv'?: '1' | '2';
1444
1742
  /** OAuth access token. */
1445
1743
  access_token?: string;
1446
1744
  /** Data format for response. */
1447
- alt?: string;
1745
+ alt?: 'json' | 'media' | 'proto';
1448
1746
  /** JSONP */
1449
1747
  callback?: string;
1450
1748
  /** Selector specifying which fields to include in a partial response. */
@@ -1467,11 +1765,11 @@ declare namespace gapi.client {
1467
1765
  /** Returns information about all transfer configs owned by a project in the specified location. */
1468
1766
  list(request?: {
1469
1767
  /** V1 error format. */
1470
- '$.xgafv'?: string;
1768
+ '$.xgafv'?: '1' | '2';
1471
1769
  /** OAuth access token. */
1472
1770
  access_token?: string;
1473
1771
  /** Data format for response. */
1474
- alt?: string;
1772
+ alt?: 'json' | 'media' | 'proto';
1475
1773
  /** JSONP */
1476
1774
  callback?: string;
1477
1775
  /** When specified, only configurations of requested data sources are returned. */
@@ -1500,11 +1798,11 @@ declare namespace gapi.client {
1500
1798
  /** Updates a data transfer configuration. All fields must be set, even if they are not updated. */
1501
1799
  patch(request: {
1502
1800
  /** V1 error format. */
1503
- '$.xgafv'?: string;
1801
+ '$.xgafv'?: '1' | '2';
1504
1802
  /** OAuth access token. */
1505
1803
  access_token?: string;
1506
1804
  /** Data format for response. */
1507
- alt?: string;
1805
+ alt?: 'json' | 'media' | 'proto';
1508
1806
  /** Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. */
1509
1807
  authorizationCode?: string;
1510
1808
  /** JSONP */
@@ -1537,11 +1835,11 @@ declare namespace gapi.client {
1537
1835
  patch(
1538
1836
  request: {
1539
1837
  /** V1 error format. */
1540
- '$.xgafv'?: string;
1838
+ '$.xgafv'?: '1' | '2';
1541
1839
  /** OAuth access token. */
1542
1840
  access_token?: string;
1543
1841
  /** Data format for response. */
1544
- alt?: string;
1842
+ alt?: 'json' | 'media' | 'proto';
1545
1843
  /** Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. */
1546
1844
  authorizationCode?: string;
1547
1845
  /** JSONP */
@@ -1574,11 +1872,11 @@ declare namespace gapi.client {
1574
1872
  /** 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. */
1575
1873
  scheduleRuns(request: {
1576
1874
  /** V1 error format. */
1577
- '$.xgafv'?: string;
1875
+ '$.xgafv'?: '1' | '2';
1578
1876
  /** OAuth access token. */
1579
1877
  access_token?: string;
1580
1878
  /** Data format for response. */
1581
- alt?: string;
1879
+ alt?: 'json' | 'media' | 'proto';
1582
1880
  /** JSONP */
1583
1881
  callback?: string;
1584
1882
  /** Selector specifying which fields to include in a partial response. */
@@ -1603,11 +1901,11 @@ declare namespace gapi.client {
1603
1901
  scheduleRuns(
1604
1902
  request: {
1605
1903
  /** V1 error format. */
1606
- '$.xgafv'?: string;
1904
+ '$.xgafv'?: '1' | '2';
1607
1905
  /** OAuth access token. */
1608
1906
  access_token?: string;
1609
1907
  /** Data format for response. */
1610
- alt?: string;
1908
+ alt?: 'json' | 'media' | 'proto';
1611
1909
  /** JSONP */
1612
1910
  callback?: string;
1613
1911
  /** Selector specifying which fields to include in a partial response. */
@@ -1632,11 +1930,11 @@ declare namespace gapi.client {
1632
1930
  /** Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each. */
1633
1931
  startManualRuns(request: {
1634
1932
  /** V1 error format. */
1635
- '$.xgafv'?: string;
1933
+ '$.xgafv'?: '1' | '2';
1636
1934
  /** OAuth access token. */
1637
1935
  access_token?: string;
1638
1936
  /** Data format for response. */
1639
- alt?: string;
1937
+ alt?: 'json' | 'media' | 'proto';
1640
1938
  /** JSONP */
1641
1939
  callback?: string;
1642
1940
  /** Selector specifying which fields to include in a partial response. */
@@ -1661,11 +1959,11 @@ declare namespace gapi.client {
1661
1959
  startManualRuns(
1662
1960
  request: {
1663
1961
  /** V1 error format. */
1664
- '$.xgafv'?: string;
1962
+ '$.xgafv'?: '1' | '2';
1665
1963
  /** OAuth access token. */
1666
1964
  access_token?: string;
1667
1965
  /** Data format for response. */
1668
- alt?: string;
1966
+ alt?: 'json' | 'media' | 'proto';
1669
1967
  /** JSONP */
1670
1968
  callback?: string;
1671
1969
  /** Selector specifying which fields to include in a partial response. */
@@ -1688,16 +1986,17 @@ declare namespace gapi.client {
1688
1986
  body: StartManualTransferRunsRequest,
1689
1987
  ): Request<StartManualTransferRunsResponse>;
1690
1988
  runs: RunsResource;
1989
+ transferResources: TransferResourcesResource;
1691
1990
  }
1692
1991
  interface ProjectsResource {
1693
1992
  /** 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://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers). */
1694
1993
  enrollDataSources(request: {
1695
1994
  /** V1 error format. */
1696
- '$.xgafv'?: string;
1995
+ '$.xgafv'?: '1' | '2';
1697
1996
  /** OAuth access token. */
1698
1997
  access_token?: string;
1699
1998
  /** Data format for response. */
1700
- alt?: string;
1999
+ alt?: 'json' | 'media' | 'proto';
1701
2000
  /** JSONP */
1702
2001
  callback?: string;
1703
2002
  /** Selector specifying which fields to include in a partial response. */
@@ -1722,11 +2021,11 @@ declare namespace gapi.client {
1722
2021
  enrollDataSources(
1723
2022
  request: {
1724
2023
  /** V1 error format. */
1725
- '$.xgafv'?: string;
2024
+ '$.xgafv'?: '1' | '2';
1726
2025
  /** OAuth access token. */
1727
2026
  access_token?: string;
1728
2027
  /** Data format for response. */
1729
- alt?: string;
2028
+ alt?: 'json' | 'media' | 'proto';
1730
2029
  /** JSONP */
1731
2030
  callback?: string;
1732
2031
  /** Selector specifying which fields to include in a partial response. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.bigquerydatatransfer-v1",
3
- "version": "0.1.20260310",
3
+ "version": "0.1.20260601",
4
4
  "description": "TypeScript typings for BigQuery Data Transfer API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -11,6 +11,23 @@ Install typings for BigQuery Data Transfer API:
11
11
  npm install @types/gapi.client.bigquerydatatransfer-v1 --save-dev
12
12
  ```
13
13
 
14
+ ## TypeScript 6.0+
15
+
16
+ TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
17
+
18
+ ```json
19
+ {
20
+ "compilerOptions": {
21
+ "types": [
22
+ "gapi",
23
+ "gapi.auth2",
24
+ "gapi.client",
25
+ "gapi.client.bigquerydatatransfer-v1"
26
+ ]
27
+ }
28
+ }
29
+ ```
30
+
14
31
  ## Usage
15
32
 
16
33
  You need to initialize Google API client in your code: