v1.d.ts
103 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace bigquerydatatransfer_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* BigQuery Data Transfer API
*
* Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.
*
* @example
* const {google} = require('googleapis');
* const bigquerydatatransfer = google.bigquerydatatransfer('v1');
*
* @namespace bigquerydatatransfer
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Bigquerydatatransfer
*/
export class Bigquerydatatransfer {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
*/
export interface Schema$CheckValidCredsRequest {
}
/**
* A response indicating whether the credentials exist and are valid.
*/
export interface Schema$CheckValidCredsResponse {
/**
* If set to `true`, the credentials exist and are valid.
*/
hasValidCreds?: boolean | null;
}
/**
* Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
*/
export interface Schema$DataSource {
/**
* Indicates the type of authorization.
*/
authorizationType?: string | null;
/**
* Data source client id which should be used to receive refresh token.
*/
clientId?: string | null;
/**
* 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.
*/
dataRefreshType?: string | null;
/**
* Data source id.
*/
dataSourceId?: string | null;
/**
* Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
*/
defaultDataRefreshWindowDays?: number | null;
/**
* Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.
*/
defaultSchedule?: string | null;
/**
* User friendly data source description string.
*/
description?: string | null;
/**
* User friendly data source name.
*/
displayName?: string | null;
/**
* Url for the help document for this data source.
*/
helpUrl?: string | null;
/**
* Disables backfilling and manual run scheduling for the data source.
*/
manualRunsDisabled?: boolean | null;
/**
* The minimum interval for scheduler to schedule runs.
*/
minimumScheduleInterval?: string | null;
/**
* Output only. Data source resource name.
*/
name?: string | null;
/**
* Data source parameters.
*/
parameters?: Schema$DataSourceParameter[];
/**
* Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
*/
scopes?: string[] | null;
/**
* Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule.
*/
supportsCustomSchedule?: boolean | null;
/**
* Deprecated. This field has no effect.
*/
supportsMultipleTransfers?: boolean | null;
/**
* Deprecated. This field has no effect.
*/
transferType?: string | null;
/**
* The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
*/
updateDeadlineSeconds?: number | null;
}
/**
* Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.
*/
export interface Schema$DataSourceParameter {
/**
* All possible values for the parameter.
*/
allowedValues?: string[] | null;
/**
* If true, it should not be used in new transfers, and it should not be visible to users.
*/
deprecated?: boolean | null;
/**
* Parameter description.
*/
description?: string | null;
/**
* Parameter display name in the user interface.
*/
displayName?: string | null;
/**
* Deprecated. This field has no effect.
*/
fields?: Schema$DataSourceParameter[];
/**
* Cannot be changed after initial creation.
*/
immutable?: boolean | null;
/**
* For integer and double values specifies maxminum allowed value.
*/
maxValue?: number | null;
/**
* For integer and double values specifies minimum allowed value.
*/
minValue?: number | null;
/**
* Parameter identifier.
*/
paramId?: string | null;
/**
* Deprecated. This field has no effect.
*/
recurse?: boolean | null;
/**
* Deprecated. This field has no effect.
*/
repeated?: boolean | null;
/**
* Is parameter required.
*/
required?: boolean | null;
/**
* Parameter type.
*/
type?: string | null;
/**
* Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
*/
validationDescription?: string | null;
/**
* URL to a help document to further explain the naming requirements.
*/
validationHelpUrl?: string | null;
/**
* Regular expression which can be used for parameter validation.
*/
validationRegex?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {
}
/**
* Returns list of supported data sources and their metadata.
*/
export interface Schema$ListDataSourcesResponse {
/**
* List of supported data sources and their transfer settings.
*/
dataSources?: Schema$DataSource[];
/**
* Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results.
*/
nextPageToken?: string | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* The returned list of pipelines in the project.
*/
export interface Schema$ListTransferConfigsResponse {
/**
* Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.
*/
nextPageToken?: string | null;
/**
* Output only. The stored pipeline transfer configurations.
*/
transferConfigs?: Schema$TransferConfig[];
}
/**
* The returned list transfer run messages.
*/
export interface Schema$ListTransferLogsResponse {
/**
* Output only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results.
*/
nextPageToken?: string | null;
/**
* Output only. The stored pipeline transfer messages.
*/
transferMessages?: Schema$TransferMessage[];
}
/**
* The returned list of pipelines in the project.
*/
export interface Schema$ListTransferRunsResponse {
/**
* 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.
*/
nextPageToken?: string | null;
/**
* Output only. The stored pipeline transfer runs.
*/
transferRuns?: Schema$TransferRun[];
}
/**
* A resource that represents Google Cloud Platform location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* Options customizing the data transfer schedule.
*/
export interface Schema$ScheduleOptions {
/**
* 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.
*/
disableAutoScheduling?: boolean | null;
/**
* Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
*/
endTime?: string | null;
/**
* Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
*/
startTime?: string | null;
}
/**
* A request to schedule transfer runs for a time range.
*/
export interface Schema$ScheduleTransferRunsRequest {
/**
* Required. End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`.
*/
endTime?: string | null;
/**
* Required. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.
*/
startTime?: string | null;
}
/**
* A response to schedule transfer runs for a time range.
*/
export interface Schema$ScheduleTransferRunsResponse {
/**
* The transfer runs that were scheduled.
*/
runs?: Schema$TransferRun[];
}
/**
* A request to start manual transfer runs.
*/
export interface Schema$StartManualTransferRunsRequest {
/**
* Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.
*/
requestedRunTime?: string | null;
/**
* Time range for the transfer runs that should be started.
*/
requestedTimeRange?: Schema$TimeRange;
}
/**
* A response to start manual transfer runs.
*/
export interface Schema$StartManualTransferRunsResponse {
/**
* The transfer runs that were created.
*/
runs?: Schema$TransferRun[];
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* 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.
*/
message?: string | null;
}
/**
* A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
*/
export interface Schema$TimeRange {
/**
* End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range betwen start_time (inclusive) and end_time (exlusive).
*/
endTime?: string | null;
/**
* Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range betwen start_time (inclusive) and end_time (exlusive).
*/
startTime?: string | null;
}
/**
* Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
*/
export interface Schema$TransferConfig {
/**
* The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
*/
dataRefreshWindowDays?: number | null;
/**
* Output only. Region in which BigQuery dataset is located.
*/
datasetRegion?: string | null;
/**
* Data source id. Cannot be changed once data transfer is created.
*/
dataSourceId?: string | null;
/**
* The BigQuery target dataset id.
*/
destinationDatasetId?: string | null;
/**
* Is this config disabled. When set to true, no runs are scheduled for a given transfer.
*/
disabled?: boolean | null;
/**
* User specified display name for the data transfer.
*/
displayName?: string | null;
/**
* The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
*/
name?: string | null;
/**
* Output only. Next time when data transfer will run.
*/
nextRunTime?: string | null;
/**
* Data transfer specific parameters.
*/
params?: {
[key: string]: any;
} | null;
/**
* Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
*/
schedule?: string | null;
/**
* Options customizing the data transfer schedule.
*/
scheduleOptions?: Schema$ScheduleOptions;
/**
* Output only. State of the most recently updated transfer run.
*/
state?: string | null;
/**
* Output only. Data transfer modification time. Ignored by server on input.
*/
updateTime?: string | null;
/**
* Deprecated. Unique ID of the user on whose behalf transfer is done.
*/
userId?: string | null;
}
/**
* Represents a user facing message for a particular data transfer run.
*/
export interface Schema$TransferMessage {
/**
* Message text.
*/
messageText?: string | null;
/**
* Time when message was logged.
*/
messageTime?: string | null;
/**
* Message severity.
*/
severity?: string | null;
}
/**
* Represents a data transfer run.
*/
export interface Schema$TransferRun {
/**
* Output only. Data source id.
*/
dataSourceId?: string | null;
/**
* Output only. The BigQuery target dataset id.
*/
destinationDatasetId?: string | null;
/**
* Output only. Time when transfer run ended. Parameter ignored by server for input requests.
*/
endTime?: string | null;
/**
* Status of the transfer run.
*/
errorStatus?: Schema$Status;
/**
* 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.
*/
name?: string | null;
/**
* Output only. Data transfer specific parameters.
*/
params?: {
[key: string]: any;
} | null;
/**
* For batch transfer runs, specifies the date and time of the data should be ingested.
*/
runTime?: string | null;
/**
* Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
*/
schedule?: string | null;
/**
* Minimum time after which a transfer run can be started.
*/
scheduleTime?: string | null;
/**
* Output only. Time when transfer run was started. Parameter ignored by server for input requests.
*/
startTime?: string | null;
/**
* Data transfer run state. Ignored for input requests.
*/
state?: string | null;
/**
* Output only. Last time the data transfer run state was updated.
*/
updateTime?: string | null;
/**
* Deprecated. Unique ID of the user on whose behalf transfer is done.
*/
userId?: string | null;
}
export class Resource$Projects {
context: APIRequestContext;
dataSources: Resource$Projects$Datasources;
locations: Resource$Projects$Locations;
transferConfigs: Resource$Projects$Transferconfigs;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Datasources {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.dataSources.checkValidCreds
* @desc 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.
* @alias bigquerydatatransfer.projects.dataSources.checkValidCreds
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`
* @param {().CheckValidCredsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
checkValidCreds(params?: Params$Resource$Projects$Datasources$Checkvalidcreds, options?: MethodOptions): GaxiosPromise<Schema$CheckValidCredsResponse>;
checkValidCreds(params: Params$Resource$Projects$Datasources$Checkvalidcreds, options: MethodOptions | BodyResponseCallback<Schema$CheckValidCredsResponse>, callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
checkValidCreds(params: Params$Resource$Projects$Datasources$Checkvalidcreds, callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
checkValidCreds(callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
/**
* bigquerydatatransfer.projects.dataSources.get
* @desc Retrieves a supported data source and returns its settings, which can be used for UI rendering.
* @alias bigquerydatatransfer.projects.dataSources.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Datasources$Get, options?: MethodOptions): GaxiosPromise<Schema$DataSource>;
get(params: Params$Resource$Projects$Datasources$Get, options: MethodOptions | BodyResponseCallback<Schema$DataSource>, callback: BodyResponseCallback<Schema$DataSource>): void;
get(params: Params$Resource$Projects$Datasources$Get, callback: BodyResponseCallback<Schema$DataSource>): void;
get(callback: BodyResponseCallback<Schema$DataSource>): void;
/**
* bigquerydatatransfer.projects.dataSources.list
* @desc Lists supported data sources and returns their settings, which can be used for UI rendering.
* @alias bigquerydatatransfer.projects.dataSources.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Datasources$List, options?: MethodOptions): GaxiosPromise<Schema$ListDataSourcesResponse>;
list(params: Params$Resource$Projects$Datasources$List, options: MethodOptions | BodyResponseCallback<Schema$ListDataSourcesResponse>, callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
list(params: Params$Resource$Projects$Datasources$List, callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
}
export interface Params$Resource$Projects$Datasources$Checkvalidcreds extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CheckValidCredsRequest;
}
export interface Params$Resource$Projects$Datasources$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Datasources$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`
*/
parent?: string;
}
export class Resource$Projects$Locations {
context: APIRequestContext;
dataSources: Resource$Projects$Locations$Datasources;
transferConfigs: Resource$Projects$Locations$Transferconfigs;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.locations.get
* @desc Gets information about a location.
* @alias bigquerydatatransfer.projects.locations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for the location.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions): GaxiosPromise<Schema$Location>;
get(params: Params$Resource$Projects$Locations$Get, options: MethodOptions | BodyResponseCallback<Schema$Location>, callback: BodyResponseCallback<Schema$Location>): void;
get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$Location>): void;
get(callback: BodyResponseCallback<Schema$Location>): void;
/**
* bigquerydatatransfer.projects.locations.list
* @desc Lists information about the supported locations for this service.
* @alias bigquerydatatransfer.projects.locations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The standard list filter.
* @param {string} params.name The resource that owns the locations collection, if applicable.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Locations$List, options?: MethodOptions): GaxiosPromise<Schema$ListLocationsResponse>;
list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name for the location.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The standard list filter.
*/
filter?: string;
/**
* The resource that owns the locations collection, if applicable.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
export class Resource$Projects$Locations$Datasources {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.locations.dataSources.checkValidCreds
* @desc 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.
* @alias bigquerydatatransfer.projects.locations.dataSources.checkValidCreds
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`
* @param {().CheckValidCredsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
checkValidCreds(params?: Params$Resource$Projects$Locations$Datasources$Checkvalidcreds, options?: MethodOptions): GaxiosPromise<Schema$CheckValidCredsResponse>;
checkValidCreds(params: Params$Resource$Projects$Locations$Datasources$Checkvalidcreds, options: MethodOptions | BodyResponseCallback<Schema$CheckValidCredsResponse>, callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
checkValidCreds(params: Params$Resource$Projects$Locations$Datasources$Checkvalidcreds, callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
checkValidCreds(callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
/**
* bigquerydatatransfer.projects.locations.dataSources.get
* @desc Retrieves a supported data source and returns its settings, which can be used for UI rendering.
* @alias bigquerydatatransfer.projects.locations.dataSources.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Locations$Datasources$Get, options?: MethodOptions): GaxiosPromise<Schema$DataSource>;
get(params: Params$Resource$Projects$Locations$Datasources$Get, options: MethodOptions | BodyResponseCallback<Schema$DataSource>, callback: BodyResponseCallback<Schema$DataSource>): void;
get(params: Params$Resource$Projects$Locations$Datasources$Get, callback: BodyResponseCallback<Schema$DataSource>): void;
get(callback: BodyResponseCallback<Schema$DataSource>): void;
/**
* bigquerydatatransfer.projects.locations.dataSources.list
* @desc Lists supported data sources and returns their settings, which can be used for UI rendering.
* @alias bigquerydatatransfer.projects.locations.dataSources.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Locations$Datasources$List, options?: MethodOptions): GaxiosPromise<Schema$ListDataSourcesResponse>;
list(params: Params$Resource$Projects$Locations$Datasources$List, options: MethodOptions | BodyResponseCallback<Schema$ListDataSourcesResponse>, callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
list(params: Params$Resource$Projects$Locations$Datasources$List, callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
}
export interface Params$Resource$Projects$Locations$Datasources$Checkvalidcreds extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CheckValidCredsRequest;
}
export interface Params$Resource$Projects$Locations$Datasources$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Datasources$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`
*/
parent?: string;
}
export class Resource$Projects$Locations$Transferconfigs {
context: APIRequestContext;
runs: Resource$Projects$Locations$Transferconfigs$Runs;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.locations.transferConfigs.create
* @desc Creates a new data transfer configuration.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
* @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
* @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
* @param {().TransferConfig} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Locations$Transferconfigs$Create, options?: MethodOptions): GaxiosPromise<Schema$TransferConfig>;
create(params: Params$Resource$Projects$Locations$Transferconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$TransferConfig>, callback: BodyResponseCallback<Schema$TransferConfig>): void;
create(params: Params$Resource$Projects$Locations$Transferconfigs$Create, callback: BodyResponseCallback<Schema$TransferConfig>): void;
create(callback: BodyResponseCallback<Schema$TransferConfig>): void;
/**
* bigquerydatatransfer.projects.locations.transferConfigs.delete
* @desc Deletes a data transfer configuration, including any associated transfer runs and logs.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Locations$Transferconfigs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Locations$Transferconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Locations$Transferconfigs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* bigquerydatatransfer.projects.locations.transferConfigs.get
* @desc Returns information about a data transfer config.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Locations$Transferconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$TransferConfig>;
get(params: Params$Resource$Projects$Locations$Transferconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$TransferConfig>, callback: BodyResponseCallback<Schema$TransferConfig>): void;
get(params: Params$Resource$Projects$Locations$Transferconfigs$Get, callback: BodyResponseCallback<Schema$TransferConfig>): void;
get(callback: BodyResponseCallback<Schema$TransferConfig>): void;
/**
* bigquerydatatransfer.projects.locations.transferConfigs.list
* @desc Returns information about all data transfers in the project.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.dataSourceIds When specified, only configurations of requested data sources are returned.
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Locations$Transferconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$ListTransferConfigsResponse>;
list(params: Params$Resource$Projects$Locations$Transferconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$ListTransferConfigsResponse>, callback: BodyResponseCallback<Schema$ListTransferConfigsResponse>): void;
list(params: Params$Resource$Projects$Locations$Transferconfigs$List, callback: BodyResponseCallback<Schema$ListTransferConfigsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTransferConfigsResponse>): void;
/**
* bigquerydatatransfer.projects.locations.transferConfigs.patch
* @desc Updates a data transfer configuration. All fields must be set, even if they are not updated.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
* @param {string} params.name The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
* @param {string=} params.updateMask Required. Required list of fields to be updated in this request.
* @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
* @param {().TransferConfig} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Locations$Transferconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$TransferConfig>;
patch(params: Params$Resource$Projects$Locations$Transferconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$TransferConfig>, callback: BodyResponseCallback<Schema$TransferConfig>): void;
patch(params: Params$Resource$Projects$Locations$Transferconfigs$Patch, callback: BodyResponseCallback<Schema$TransferConfig>): void;
patch(callback: BodyResponseCallback<Schema$TransferConfig>): void;
/**
* bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns
* @desc 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.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
* @param {().ScheduleTransferRunsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
scheduleRuns(params?: Params$Resource$Projects$Locations$Transferconfigs$Scheduleruns, options?: MethodOptions): GaxiosPromise<Schema$ScheduleTransferRunsResponse>;
scheduleRuns(params: Params$Resource$Projects$Locations$Transferconfigs$Scheduleruns, options: MethodOptions | BodyResponseCallback<Schema$ScheduleTransferRunsResponse>, callback: BodyResponseCallback<Schema$ScheduleTransferRunsResponse>): void;
scheduleRuns(params: Params$Resource$Projects$Locations$Transferconfigs$Scheduleruns, callback: BodyResponseCallback<Schema$ScheduleTransferRunsResponse>): void;
scheduleRuns(callback: BodyResponseCallback<Schema$ScheduleTransferRunsResponse>): void;
/**
* bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns
* @desc 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.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
* @param {().StartManualTransferRunsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
startManualRuns(params?: Params$Resource$Projects$Locations$Transferconfigs$Startmanualruns, options?: MethodOptions): GaxiosPromise<Schema$StartManualTransferRunsResponse>;
startManualRuns(params: Params$Resource$Projects$Locations$Transferconfigs$Startmanualruns, options: MethodOptions | BodyResponseCallback<Schema$StartManualTransferRunsResponse>, callback: BodyResponseCallback<Schema$StartManualTransferRunsResponse>): void;
startManualRuns(params: Params$Resource$Projects$Locations$Transferconfigs$Startmanualruns, callback: BodyResponseCallback<Schema$StartManualTransferRunsResponse>): void;
startManualRuns(callback: BodyResponseCallback<Schema$StartManualTransferRunsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
*/
authorizationCode?: string;
/**
* Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
*/
parent?: string;
/**
* Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
*/
versionInfo?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TransferConfig;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* When specified, only configurations of requested data sources are returned.
*/
dataSourceIds?: string[];
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
*/
authorizationCode?: string;
/**
* The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
*/
name?: string;
/**
* Required. Required list of fields to be updated in this request.
*/
updateMask?: string;
/**
* Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
*/
versionInfo?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TransferConfig;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Scheduleruns extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ScheduleTransferRunsRequest;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Startmanualruns extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$StartManualTransferRunsRequest;
}
export class Resource$Projects$Locations$Transferconfigs$Runs {
context: APIRequestContext;
transferLogs: Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.locations.transferConfigs.runs.delete
* @desc Deletes the specified transfer run.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.runs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Locations$Transferconfigs$Runs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Locations$Transferconfigs$Runs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Locations$Transferconfigs$Runs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* bigquerydatatransfer.projects.locations.transferConfigs.runs.get
* @desc Returns information about the particular transfer run.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.runs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Locations$Transferconfigs$Runs$Get, options?: MethodOptions): GaxiosPromise<Schema$TransferRun>;
get(params: Params$Resource$Projects$Locations$Transferconfigs$Runs$Get, options: MethodOptions | BodyResponseCallback<Schema$TransferRun>, callback: BodyResponseCallback<Schema$TransferRun>): void;
get(params: Params$Resource$Projects$Locations$Transferconfigs$Runs$Get, callback: BodyResponseCallback<Schema$TransferRun>): void;
get(callback: BodyResponseCallback<Schema$TransferRun>): void;
/**
* bigquerydatatransfer.projects.locations.transferConfigs.runs.list
* @desc Returns information about running and completed jobs.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.runs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`.
* @param {string=} params.runAttempt Indicates how run attempts are to be pulled.
* @param {string=} params.states When specified, only transfer runs with requested states are returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Locations$Transferconfigs$Runs$List, options?: MethodOptions): GaxiosPromise<Schema$ListTransferRunsResponse>;
list(params: Params$Resource$Projects$Locations$Transferconfigs$Runs$List, options: MethodOptions | BodyResponseCallback<Schema$ListTransferRunsResponse>, callback: BodyResponseCallback<Schema$ListTransferRunsResponse>): void;
list(params: Params$Resource$Projects$Locations$Transferconfigs$Runs$List, callback: BodyResponseCallback<Schema$ListTransferRunsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTransferRunsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
/**
* Indicates how run attempts are to be pulled.
*/
runAttempt?: string;
/**
* When specified, only transfer runs with requested states are returned.
*/
states?: string[];
}
export class Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list
* @desc Returns user facing log messages for the data transfer run.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.messageTypes Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs$List, options?: MethodOptions): GaxiosPromise<Schema$ListTransferLogsResponse>;
list(params: Params$Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs$List, options: MethodOptions | BodyResponseCallback<Schema$ListTransferLogsResponse>, callback: BodyResponseCallback<Schema$ListTransferLogsResponse>): void;
list(params: Params$Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs$List, callback: BodyResponseCallback<Schema$ListTransferLogsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTransferLogsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
*/
messageTypes?: string[];
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
*/
parent?: string;
}
export class Resource$Projects$Transferconfigs {
context: APIRequestContext;
runs: Resource$Projects$Transferconfigs$Runs;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.transferConfigs.create
* @desc Creates a new data transfer configuration.
* @alias bigquerydatatransfer.projects.transferConfigs.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
* @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
* @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
* @param {().TransferConfig} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Transferconfigs$Create, options?: MethodOptions): GaxiosPromise<Schema$TransferConfig>;
create(params: Params$Resource$Projects$Transferconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$TransferConfig>, callback: BodyResponseCallback<Schema$TransferConfig>): void;
create(params: Params$Resource$Projects$Transferconfigs$Create, callback: BodyResponseCallback<Schema$TransferConfig>): void;
create(callback: BodyResponseCallback<Schema$TransferConfig>): void;
/**
* bigquerydatatransfer.projects.transferConfigs.delete
* @desc Deletes a data transfer configuration, including any associated transfer runs and logs.
* @alias bigquerydatatransfer.projects.transferConfigs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Transferconfigs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Transferconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Transferconfigs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* bigquerydatatransfer.projects.transferConfigs.get
* @desc Returns information about a data transfer config.
* @alias bigquerydatatransfer.projects.transferConfigs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Transferconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$TransferConfig>;
get(params: Params$Resource$Projects$Transferconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$TransferConfig>, callback: BodyResponseCallback<Schema$TransferConfig>): void;
get(params: Params$Resource$Projects$Transferconfigs$Get, callback: BodyResponseCallback<Schema$TransferConfig>): void;
get(callback: BodyResponseCallback<Schema$TransferConfig>): void;
/**
* bigquerydatatransfer.projects.transferConfigs.list
* @desc Returns information about all data transfers in the project.
* @alias bigquerydatatransfer.projects.transferConfigs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.dataSourceIds When specified, only configurations of requested data sources are returned.
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Transferconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$ListTransferConfigsResponse>;
list(params: Params$Resource$Projects$Transferconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$ListTransferConfigsResponse>, callback: BodyResponseCallback<Schema$ListTransferConfigsResponse>): void;
list(params: Params$Resource$Projects$Transferconfigs$List, callback: BodyResponseCallback<Schema$ListTransferConfigsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTransferConfigsResponse>): void;
/**
* bigquerydatatransfer.projects.transferConfigs.patch
* @desc Updates a data transfer configuration. All fields must be set, even if they are not updated.
* @alias bigquerydatatransfer.projects.transferConfigs.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
* @param {string} params.name The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
* @param {string=} params.updateMask Required. Required list of fields to be updated in this request.
* @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
* @param {().TransferConfig} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Transferconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$TransferConfig>;
patch(params: Params$Resource$Projects$Transferconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$TransferConfig>, callback: BodyResponseCallback<Schema$TransferConfig>): void;
patch(params: Params$Resource$Projects$Transferconfigs$Patch, callback: BodyResponseCallback<Schema$TransferConfig>): void;
patch(callback: BodyResponseCallback<Schema$TransferConfig>): void;
/**
* bigquerydatatransfer.projects.transferConfigs.scheduleRuns
* @desc 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.
* @alias bigquerydatatransfer.projects.transferConfigs.scheduleRuns
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
* @param {().ScheduleTransferRunsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
scheduleRuns(params?: Params$Resource$Projects$Transferconfigs$Scheduleruns, options?: MethodOptions): GaxiosPromise<Schema$ScheduleTransferRunsResponse>;
scheduleRuns(params: Params$Resource$Projects$Transferconfigs$Scheduleruns, options: MethodOptions | BodyResponseCallback<Schema$ScheduleTransferRunsResponse>, callback: BodyResponseCallback<Schema$ScheduleTransferRunsResponse>): void;
scheduleRuns(params: Params$Resource$Projects$Transferconfigs$Scheduleruns, callback: BodyResponseCallback<Schema$ScheduleTransferRunsResponse>): void;
scheduleRuns(callback: BodyResponseCallback<Schema$ScheduleTransferRunsResponse>): void;
/**
* bigquerydatatransfer.projects.transferConfigs.startManualRuns
* @desc 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.
* @alias bigquerydatatransfer.projects.transferConfigs.startManualRuns
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
* @param {().StartManualTransferRunsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
startManualRuns(params?: Params$Resource$Projects$Transferconfigs$Startmanualruns, options?: MethodOptions): GaxiosPromise<Schema$StartManualTransferRunsResponse>;
startManualRuns(params: Params$Resource$Projects$Transferconfigs$Startmanualruns, options: MethodOptions | BodyResponseCallback<Schema$StartManualTransferRunsResponse>, callback: BodyResponseCallback<Schema$StartManualTransferRunsResponse>): void;
startManualRuns(params: Params$Resource$Projects$Transferconfigs$Startmanualruns, callback: BodyResponseCallback<Schema$StartManualTransferRunsResponse>): void;
startManualRuns(callback: BodyResponseCallback<Schema$StartManualTransferRunsResponse>): void;
}
export interface Params$Resource$Projects$Transferconfigs$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
*/
authorizationCode?: string;
/**
* Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
*/
parent?: string;
/**
* Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
*/
versionInfo?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TransferConfig;
}
export interface Params$Resource$Projects$Transferconfigs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Transferconfigs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Transferconfigs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* When specified, only configurations of requested data sources are returned.
*/
dataSourceIds?: string[];
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Transferconfigs$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
*/
authorizationCode?: string;
/**
* The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
*/
name?: string;
/**
* Required. Required list of fields to be updated in this request.
*/
updateMask?: string;
/**
* Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
*/
versionInfo?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TransferConfig;
}
export interface Params$Resource$Projects$Transferconfigs$Scheduleruns extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ScheduleTransferRunsRequest;
}
export interface Params$Resource$Projects$Transferconfigs$Startmanualruns extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$StartManualTransferRunsRequest;
}
export class Resource$Projects$Transferconfigs$Runs {
context: APIRequestContext;
transferLogs: Resource$Projects$Transferconfigs$Runs$Transferlogs;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.transferConfigs.runs.delete
* @desc Deletes the specified transfer run.
* @alias bigquerydatatransfer.projects.transferConfigs.runs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Transferconfigs$Runs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Transferconfigs$Runs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Transferconfigs$Runs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* bigquerydatatransfer.projects.transferConfigs.runs.get
* @desc Returns information about the particular transfer run.
* @alias bigquerydatatransfer.projects.transferConfigs.runs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Transferconfigs$Runs$Get, options?: MethodOptions): GaxiosPromise<Schema$TransferRun>;
get(params: Params$Resource$Projects$Transferconfigs$Runs$Get, options: MethodOptions | BodyResponseCallback<Schema$TransferRun>, callback: BodyResponseCallback<Schema$TransferRun>): void;
get(params: Params$Resource$Projects$Transferconfigs$Runs$Get, callback: BodyResponseCallback<Schema$TransferRun>): void;
get(callback: BodyResponseCallback<Schema$TransferRun>): void;
/**
* bigquerydatatransfer.projects.transferConfigs.runs.list
* @desc Returns information about running and completed jobs.
* @alias bigquerydatatransfer.projects.transferConfigs.runs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`.
* @param {string=} params.runAttempt Indicates how run attempts are to be pulled.
* @param {string=} params.states When specified, only transfer runs with requested states are returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Transferconfigs$Runs$List, options?: MethodOptions): GaxiosPromise<Schema$ListTransferRunsResponse>;
list(params: Params$Resource$Projects$Transferconfigs$Runs$List, options: MethodOptions | BodyResponseCallback<Schema$ListTransferRunsResponse>, callback: BodyResponseCallback<Schema$ListTransferRunsResponse>): void;
list(params: Params$Resource$Projects$Transferconfigs$Runs$List, callback: BodyResponseCallback<Schema$ListTransferRunsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTransferRunsResponse>): void;
}
export interface Params$Resource$Projects$Transferconfigs$Runs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Transferconfigs$Runs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Transferconfigs$Runs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
/**
* Indicates how run attempts are to be pulled.
*/
runAttempt?: string;
/**
* When specified, only transfer runs with requested states are returned.
*/
states?: string[];
}
export class Resource$Projects$Transferconfigs$Runs$Transferlogs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list
* @desc Returns user facing log messages for the data transfer run.
* @alias bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.messageTypes Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Transferconfigs$Runs$Transferlogs$List, options?: MethodOptions): GaxiosPromise<Schema$ListTransferLogsResponse>;
list(params: Params$Resource$Projects$Transferconfigs$Runs$Transferlogs$List, options: MethodOptions | BodyResponseCallback<Schema$ListTransferLogsResponse>, callback: BodyResponseCallback<Schema$ListTransferLogsResponse>): void;
list(params: Params$Resource$Projects$Transferconfigs$Runs$Transferlogs$List, callback: BodyResponseCallback<Schema$ListTransferLogsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTransferLogsResponse>): void;
}
export interface Params$Resource$Projects$Transferconfigs$Runs$Transferlogs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
*/
messageTypes?: string[];
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
*/
parent?: string;
}
export {};
}