v2.d.ts
254 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
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
/**
* 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 bigquery_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: 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;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* BigQuery API
*
* A data platform for customers to create, manage, share and query data.
*
* @example
* const {google} = require('googleapis');
* const bigquery = google.bigquery('v2');
*
* @namespace bigquery
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Bigquery
*/
export class Bigquery {
context: APIRequestContext;
datasets: Resource$Datasets;
jobs: Resource$Jobs;
models: Resource$Models;
projects: Resource$Projects;
routines: Resource$Routines;
tabledata: Resource$Tabledata;
tables: Resource$Tables;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows.
*/
export interface Schema$AggregateClassificationMetrics {
/**
* Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
*/
accuracy?: number | null;
/**
* The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
*/
f1Score?: number | null;
/**
* Logarithmic Loss. For multiclass this is a macro-averaged metric.
*/
logLoss?: number | null;
/**
* Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
*/
precision?: number | null;
/**
* Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
*/
recall?: number | null;
/**
* Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
*/
rocAuc?: number | null;
/**
* Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
*/
threshold?: number | null;
}
/**
* Input/output argument of a function or a stored procedure.
*/
export interface Schema$Argument {
/**
* Optional. Defaults to FIXED_TYPE.
*/
argumentKind?: string | null;
/**
* Required unless argument_kind = ANY_TYPE.
*/
dataType?: Schema$StandardSqlDataType;
/**
* Optional. Specifies whether the argument is input or output. Can be set for procedures only.
*/
mode?: string | null;
/**
* Optional. The name of this argument. Can be absent for function return argument.
*/
name?: string | null;
}
/**
* Arima coefficients.
*/
export interface Schema$ArimaCoefficients {
/**
* Auto-regressive coefficients, an array of double.
*/
autoRegressiveCoefficients?: number[] | null;
/**
* Intercept coefficient, just a double not an array.
*/
interceptCoefficient?: number | null;
/**
* Moving-average coefficients, an array of double.
*/
movingAverageCoefficients?: number[] | null;
}
/**
* ARIMA model fitting metrics.
*/
export interface Schema$ArimaFittingMetrics {
/**
* AIC
*/
aic?: number | null;
/**
* log-likelihood
*/
logLikelihood?: number | null;
/**
* variance.
*/
variance?: number | null;
}
/**
* Arima model information.
*/
export interface Schema$ArimaModelInfo {
/**
* Arima coefficients.
*/
arimaCoefficients?: Schema$ArimaCoefficients;
/**
* Arima fitting metrics.
*/
arimaFittingMetrics?: Schema$ArimaFittingMetrics;
/**
* Non-seasonal order.
*/
nonSeasonalOrder?: Schema$ArimaOrder;
}
/**
* Arima order, can be used for both non-seasonal and seasonal parts.
*/
export interface Schema$ArimaOrder {
/**
* Order of the differencing part.
*/
d?: string | null;
/**
* Order of the autoregressive part.
*/
p?: string | null;
/**
* Order of the moving-average part.
*/
q?: string | null;
}
/**
* (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.
*/
export interface Schema$ArimaResult {
/**
* This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
*/
arimaModelInfo?: Schema$ArimaModelInfo[];
/**
* Seasonal periods. Repeated because multiple periods are supported for one time series.
*/
seasonalPeriods?: string[] | null;
}
export interface Schema$BigQueryModelTraining {
/**
* [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
*/
currentIteration?: number | null;
/**
* [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
*/
expectedTotalIterations?: string | null;
}
export interface Schema$BigtableColumn {
/**
* [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
*/
encoding?: string | null;
/**
* [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
*/
fieldName?: string | null;
/**
* [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
*/
onlyReadLatest?: boolean | null;
/**
* [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
*/
qualifierEncoded?: string | null;
qualifierString?: string | null;
/**
* [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
*/
type?: string | null;
}
export interface Schema$BigtableColumnFamily {
/**
* [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
*/
columns?: Schema$BigtableColumn[];
/**
* [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
*/
encoding?: string | null;
/**
* Identifier of the column family.
*/
familyId?: string | null;
/**
* [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
*/
onlyReadLatest?: boolean | null;
/**
* [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
*/
type?: string | null;
}
export interface Schema$BigtableOptions {
/**
* [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
*/
columnFamilies?: Schema$BigtableColumnFamily[];
/**
* [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
*/
ignoreUnspecifiedColumnFamilies?: boolean | null;
/**
* [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
*/
readRowkeyAsString?: boolean | null;
}
/**
* Evaluation metrics for binary classification/classifier models.
*/
export interface Schema$BinaryClassificationMetrics {
/**
* Aggregate classification metrics.
*/
aggregateClassificationMetrics?: Schema$AggregateClassificationMetrics;
/**
* Binary confusion matrix at multiple thresholds.
*/
binaryConfusionMatrixList?: Schema$BinaryConfusionMatrix[];
/**
* Label representing the negative class.
*/
negativeLabel?: string | null;
/**
* Label representing the positive class.
*/
positiveLabel?: string | null;
}
/**
* Confusion matrix for binary classification models.
*/
export interface Schema$BinaryConfusionMatrix {
/**
* The fraction of predictions given the correct label.
*/
accuracy?: number | null;
/**
* The equally weighted average of recall and precision.
*/
f1Score?: number | null;
/**
* Number of false samples predicted as false.
*/
falseNegatives?: string | null;
/**
* Number of false samples predicted as true.
*/
falsePositives?: string | null;
/**
* Threshold value used when computing each of the following metric.
*/
positiveClassThreshold?: number | null;
/**
* The fraction of actual positive predictions that had positive actual labels.
*/
precision?: number | null;
/**
* The fraction of actual positive labels that were given a positive prediction.
*/
recall?: number | null;
/**
* Number of true samples predicted as false.
*/
trueNegatives?: string | null;
/**
* Number of true samples predicted as true.
*/
truePositives?: string | null;
}
export interface Schema$BqmlIterationResult {
/**
* [Output-only, Beta] Time taken to run the training iteration in milliseconds.
*/
durationMs?: string | null;
/**
* [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.
*/
evalLoss?: number | null;
/**
* [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.
*/
index?: number | null;
/**
* [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.
*/
learnRate?: number | null;
/**
* [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.
*/
trainingLoss?: number | null;
}
export interface Schema$BqmlTrainingRun {
/**
* [Output-only, Beta] List of each iteration results.
*/
iterationResults?: Schema$BqmlIterationResult[];
/**
* [Output-only, Beta] Training run start time in milliseconds since the epoch.
*/
startTime?: string | null;
/**
* [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.
*/
state?: string | null;
/**
* [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.
*/
trainingOptions?: {
l1Reg?: number;
maxIteration?: string;
learnRate?: number;
minRelProgress?: number;
l2Reg?: number;
learnRateStrategy?: string;
warmStart?: boolean;
lineSearchInitLearnRate?: number;
earlyStop?: boolean;
} | null;
}
/**
* Representative value of a categorical feature.
*/
export interface Schema$CategoricalValue {
/**
* Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
*/
categoryCounts?: Schema$CategoryCount[];
}
/**
* Represents the count of a single category within the cluster.
*/
export interface Schema$CategoryCount {
/**
* The name of category.
*/
category?: string | null;
/**
* The count of training samples matching the category within the cluster.
*/
count?: string | null;
}
/**
* Message containing the information about one cluster.
*/
export interface Schema$Cluster {
/**
* Centroid id.
*/
centroidId?: string | null;
/**
* Count of training data rows that were assigned to this cluster.
*/
count?: string | null;
/**
* Values of highly variant features for this cluster.
*/
featureValues?: Schema$FeatureValue[];
}
/**
* Information about a single cluster for clustering model.
*/
export interface Schema$ClusterInfo {
/**
* Centroid id.
*/
centroidId?: string | null;
/**
* Cluster radius, the average distance from centroid to each point assigned to the cluster.
*/
clusterRadius?: number | null;
/**
* Cluster size, the total number of points assigned to the cluster.
*/
clusterSize?: string | null;
}
export interface Schema$Clustering {
/**
* [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
*/
fields?: string[] | null;
}
/**
* Evaluation metrics for clustering models.
*/
export interface Schema$ClusteringMetrics {
/**
* [Beta] Information for all clusters.
*/
clusters?: Schema$Cluster[];
/**
* Davies-Bouldin index.
*/
daviesBouldinIndex?: number | null;
/**
* Mean of squared distances between each sample to its cluster centroid.
*/
meanSquaredDistance?: number | null;
}
/**
* Confusion matrix for multi-class classification models.
*/
export interface Schema$ConfusionMatrix {
/**
* Confidence threshold used when computing the entries of the confusion matrix.
*/
confidenceThreshold?: number | null;
/**
* One row per actual label.
*/
rows?: Schema$Row[];
}
export interface Schema$CsvOptions {
/**
* [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
*/
allowJaggedRows?: boolean | null;
/**
* [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
*/
allowQuotedNewlines?: boolean | null;
/**
* [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
*/
encoding?: string | null;
/**
* [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
*/
fieldDelimiter?: string | null;
/**
* [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
*/
quote?: string | null;
/**
* [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
*/
skipLeadingRows?: string | null;
}
export interface Schema$Dataset {
/**
* [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
*/
access?: Array<{
iamMember?: string;
specialGroup?: string;
role?: string;
view?: Schema$TableReference;
groupByEmail?: string;
userByEmail?: string;
domain?: string;
}> | null;
/**
* [Output-only] The time when this dataset was created, in milliseconds since the epoch.
*/
creationTime?: string | null;
/**
* [Required] A reference that identifies the dataset.
*/
datasetReference?: Schema$DatasetReference;
defaultEncryptionConfiguration?: Schema$EncryptionConfiguration;
/**
* [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
*/
defaultPartitionExpirationMs?: string | null;
/**
* [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
*/
defaultTableExpirationMs?: string | null;
/**
* [Optional] A user-friendly description of the dataset.
*/
description?: string | null;
/**
* [Output-only] A hash of the resource.
*/
etag?: string | null;
/**
* [Optional] A descriptive name for the dataset.
*/
friendlyName?: string | null;
/**
* [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
*/
id?: string | null;
/**
* [Output-only] The resource type.
*/
kind?: string | null;
/**
* The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
*/
labels?: {
[key: string]: string;
} | null;
/**
* [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
*/
lastModifiedTime?: string | null;
/**
* The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
*/
location?: string | null;
/**
* [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
*/
selfLink?: string | null;
}
export interface Schema$DatasetList {
/**
* An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
*/
datasets?: Array<{
labels?: {
[key: string]: string;
};
datasetReference?: Schema$DatasetReference;
id?: string;
location?: string;
friendlyName?: string;
kind?: string;
}> | null;
/**
* A hash value of the results page. You can use this property to determine if the page has changed since the last request.
*/
etag?: string | null;
/**
* The list type. This property always returns the value "bigquery#datasetList".
*/
kind?: string | null;
/**
* A token that can be used to request the next results page. This property is omitted on the final results page.
*/
nextPageToken?: string | null;
}
export interface Schema$DatasetReference {
/**
* [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
*/
datasetId?: string | null;
/**
* [Optional] The ID of the project containing this dataset.
*/
projectId?: string | null;
}
export interface Schema$DestinationTableProperties {
/**
* [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
*/
description?: string | null;
/**
* [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
*/
friendlyName?: string | null;
/**
* [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
*/
labels?: {
[key: string]: string;
} | null;
}
export interface Schema$EncryptionConfiguration {
/**
* [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
*/
kmsKeyName?: string | null;
}
/**
* A single entry in the confusion matrix.
*/
export interface Schema$Entry {
/**
* Number of items being predicted as this label.
*/
itemCount?: string | null;
/**
* The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
*/
predictedLabel?: string | null;
}
export interface Schema$ErrorProto {
/**
* Debugging information. This property is internal to Google and should not be used.
*/
debugInfo?: string | null;
/**
* Specifies where the error occurred, if present.
*/
location?: string | null;
/**
* A human-readable description of the error.
*/
message?: string | null;
/**
* A short error code that summarizes the error.
*/
reason?: string | null;
}
/**
* Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models.
*/
export interface Schema$EvaluationMetrics {
/**
* Populated for binary classification/classifier models.
*/
binaryClassificationMetrics?: Schema$BinaryClassificationMetrics;
/**
* Populated for clustering models.
*/
clusteringMetrics?: Schema$ClusteringMetrics;
/**
* Populated for multi-class classification/classifier models.
*/
multiClassClassificationMetrics?: Schema$MultiClassClassificationMetrics;
/**
* Populated for regression models and explicit feedback type matrix factorization models.
*/
regressionMetrics?: Schema$RegressionMetrics;
}
export interface Schema$ExplainQueryStage {
/**
* Number of parallel input segments completed.
*/
completedParallelInputs?: string | null;
/**
* Milliseconds the average shard spent on CPU-bound tasks.
*/
computeMsAvg?: string | null;
/**
* Milliseconds the slowest shard spent on CPU-bound tasks.
*/
computeMsMax?: string | null;
/**
* Relative amount of time the average shard spent on CPU-bound tasks.
*/
computeRatioAvg?: number | null;
/**
* Relative amount of time the slowest shard spent on CPU-bound tasks.
*/
computeRatioMax?: number | null;
/**
* Stage end time represented as milliseconds since epoch.
*/
endMs?: string | null;
/**
* Unique ID for stage within plan.
*/
id?: string | null;
/**
* IDs for stages that are inputs to this stage.
*/
inputStages?: string[] | null;
/**
* Human-readable name for stage.
*/
name?: string | null;
/**
* Number of parallel input segments to be processed.
*/
parallelInputs?: string | null;
/**
* Milliseconds the average shard spent reading input.
*/
readMsAvg?: string | null;
/**
* Milliseconds the slowest shard spent reading input.
*/
readMsMax?: string | null;
/**
* Relative amount of time the average shard spent reading input.
*/
readRatioAvg?: number | null;
/**
* Relative amount of time the slowest shard spent reading input.
*/
readRatioMax?: number | null;
/**
* Number of records read into the stage.
*/
recordsRead?: string | null;
/**
* Number of records written by the stage.
*/
recordsWritten?: string | null;
/**
* Total number of bytes written to shuffle.
*/
shuffleOutputBytes?: string | null;
/**
* Total number of bytes written to shuffle and spilled to disk.
*/
shuffleOutputBytesSpilled?: string | null;
/**
* Stage start time represented as milliseconds since epoch.
*/
startMs?: string | null;
/**
* Current status for the stage.
*/
status?: string | null;
/**
* List of operations within the stage in dependency order (approximately chronological).
*/
steps?: Schema$ExplainQueryStep[];
/**
* Milliseconds the average shard spent waiting to be scheduled.
*/
waitMsAvg?: string | null;
/**
* Milliseconds the slowest shard spent waiting to be scheduled.
*/
waitMsMax?: string | null;
/**
* Relative amount of time the average shard spent waiting to be scheduled.
*/
waitRatioAvg?: number | null;
/**
* Relative amount of time the slowest shard spent waiting to be scheduled.
*/
waitRatioMax?: number | null;
/**
* Milliseconds the average shard spent on writing output.
*/
writeMsAvg?: string | null;
/**
* Milliseconds the slowest shard spent on writing output.
*/
writeMsMax?: string | null;
/**
* Relative amount of time the average shard spent on writing output.
*/
writeRatioAvg?: number | null;
/**
* Relative amount of time the slowest shard spent on writing output.
*/
writeRatioMax?: number | null;
}
export interface Schema$ExplainQueryStep {
/**
* Machine-readable operation type.
*/
kind?: string | null;
/**
* Human-readable stage descriptions.
*/
substeps?: string[] | null;
}
export interface Schema$ExternalDataConfiguration {
/**
* Try to detect schema and format options automatically. Any option specified explicitly will be honored.
*/
autodetect?: boolean | null;
/**
* [Optional] Additional options if sourceFormat is set to BIGTABLE.
*/
bigtableOptions?: Schema$BigtableOptions;
/**
* [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
*/
compression?: string | null;
/**
* Additional properties to set if sourceFormat is set to CSV.
*/
csvOptions?: Schema$CsvOptions;
/**
* [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
*/
googleSheetsOptions?: Schema$GoogleSheetsOptions;
/**
* [Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
*/
hivePartitioningMode?: string | null;
/**
* [Optional, Trusted Tester] Options to configure hive partitioning support.
*/
hivePartitioningOptions?: Schema$HivePartitioningOptions;
/**
* [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
*/
ignoreUnknownValues?: boolean | null;
/**
* [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
*/
maxBadRecords?: number | null;
/**
* [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
*/
schema?: Schema$TableSchema;
/**
* [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
*/
sourceFormat?: string | null;
/**
* [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
*/
sourceUris?: string[] | null;
}
/**
* Representative value of a single feature within the cluster.
*/
export interface Schema$FeatureValue {
/**
* The categorical feature value.
*/
categoricalValue?: Schema$CategoricalValue;
/**
* The feature column name.
*/
featureColumn?: string | null;
/**
* The numerical feature value. This is the centroid value for this feature.
*/
numericalValue?: number | null;
}
export interface Schema$GetQueryResultsResponse {
/**
* Whether the query result was fetched from the query cache.
*/
cacheHit?: boolean | null;
/**
* [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
*/
errors?: Schema$ErrorProto[];
/**
* A hash of this response.
*/
etag?: string | null;
/**
* Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
*/
jobComplete?: boolean | null;
/**
* Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
*/
jobReference?: Schema$JobReference;
/**
* The resource type of the response.
*/
kind?: string | null;
/**
* [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
*/
numDmlAffectedRows?: string | null;
/**
* A token used for paging results.
*/
pageToken?: string | null;
/**
* An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
*/
rows?: Schema$TableRow[];
/**
* The schema of the results. Present only when the query completes successfully.
*/
schema?: Schema$TableSchema;
/**
* The total number of bytes processed for this query.
*/
totalBytesProcessed?: string | null;
/**
* The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
*/
totalRows?: string | null;
}
export interface Schema$GetServiceAccountResponse {
/**
* The service account email address.
*/
email?: string | null;
/**
* The resource type of the response.
*/
kind?: string | null;
}
export interface Schema$GoogleSheetsOptions {
/**
* [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
*/
range?: string | null;
/**
* [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
*/
skipLeadingRows?: string | null;
}
export interface Schema$HivePartitioningOptions {
/**
* [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
*/
mode?: string | null;
/**
* [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
*/
sourceUriPrefix?: string | null;
}
/**
* Information about a single iteration of the training run.
*/
export interface Schema$IterationResult {
arimaResult?: Schema$ArimaResult;
/**
* Information about top clusters for clustering models.
*/
clusterInfos?: Schema$ClusterInfo[];
/**
* Time taken to run the iteration in milliseconds.
*/
durationMs?: string | null;
/**
* Loss computed on the eval data at the end of iteration.
*/
evalLoss?: number | null;
/**
* Index of the iteration, 0 based.
*/
index?: number | null;
/**
* Learn rate used for this iteration.
*/
learnRate?: number | null;
/**
* Loss computed on the training data at the end of iteration.
*/
trainingLoss?: number | null;
}
export interface Schema$Job {
/**
* [Required] Describes the job configuration.
*/
configuration?: Schema$JobConfiguration;
/**
* [Output-only] A hash of this resource.
*/
etag?: string | null;
/**
* [Output-only] Opaque ID field of the job
*/
id?: string | null;
/**
* [Optional] Reference describing the unique-per-user name of the job.
*/
jobReference?: Schema$JobReference;
/**
* [Output-only] The type of the resource.
*/
kind?: string | null;
/**
* [Output-only] A URL that can be used to access this resource again.
*/
selfLink?: string | null;
/**
* [Output-only] Information about the job, including starting time and ending time of the job.
*/
statistics?: Schema$JobStatistics;
/**
* [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
*/
status?: Schema$JobStatus;
/**
* [Output-only] Email address of the user who ran the job.
*/
user_email?: string | null;
}
export interface Schema$JobCancelResponse {
/**
* The final state of the job.
*/
job?: Schema$Job;
/**
* The resource type of the response.
*/
kind?: string | null;
}
export interface Schema$JobConfiguration {
/**
* [Pick one] Copies a table.
*/
copy?: Schema$JobConfigurationTableCopy;
/**
* [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
*/
dryRun?: boolean | null;
/**
* [Pick one] Configures an extract job.
*/
extract?: Schema$JobConfigurationExtract;
/**
* [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
*/
jobTimeoutMs?: string | null;
/**
* [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
*/
jobType?: string | null;
/**
* The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
*/
labels?: {
[key: string]: string;
} | null;
/**
* [Pick one] Configures a load job.
*/
load?: Schema$JobConfigurationLoad;
/**
* [Pick one] Configures a query job.
*/
query?: Schema$JobConfigurationQuery;
}
export interface Schema$JobConfigurationExtract {
/**
* [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro.
*/
compression?: string | null;
/**
* [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
*/
destinationFormat?: string | null;
/**
* [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
*/
destinationUri?: string | null;
/**
* [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
*/
destinationUris?: string[] | null;
/**
* [Optional] Delimiter to use between fields in the exported data. Default is ','
*/
fieldDelimiter?: string | null;
/**
* [Optional] Whether to print out a header row in the results. Default is true.
*/
printHeader?: boolean | null;
/**
* A reference to the model being exported.
*/
sourceModel?: Schema$ModelReference;
/**
* A reference to the table being exported.
*/
sourceTable?: Schema$TableReference;
/**
* [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long).
*/
useAvroLogicalTypes?: boolean | null;
}
export interface Schema$JobConfigurationLoad {
/**
* [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
*/
allowJaggedRows?: boolean | null;
/**
* Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
*/
allowQuotedNewlines?: boolean | null;
/**
* [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
*/
autodetect?: boolean | null;
/**
* [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
*/
clustering?: Schema$Clustering;
/**
* [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
createDisposition?: string | null;
/**
* Custom encryption configuration (e.g., Cloud KMS keys).
*/
destinationEncryptionConfiguration?: Schema$EncryptionConfiguration;
/**
* [Required] The destination table to load the data into.
*/
destinationTable?: Schema$TableReference;
/**
* [Beta] [Optional] Properties with which to create the destination table if it is new.
*/
destinationTableProperties?: Schema$DestinationTableProperties;
/**
* [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
*/
encoding?: string | null;
/**
* [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
*/
fieldDelimiter?: string | null;
/**
* [Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
*/
hivePartitioningMode?: string | null;
/**
* [Optional, Trusted Tester] Options to configure hive partitioning support.
*/
hivePartitioningOptions?: Schema$HivePartitioningOptions;
/**
* [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
*/
ignoreUnknownValues?: boolean | null;
/**
* [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
*/
maxBadRecords?: number | null;
/**
* [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "x/", BigQuery interprets "x/" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
*/
nullMarker?: string | null;
/**
* If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
*/
projectionFields?: string[] | null;
/**
* [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
*/
quote?: string | null;
/**
* [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
*/
rangePartitioning?: Schema$RangePartitioning;
/**
* [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
*/
schema?: Schema$TableSchema;
/**
* [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
*/
schemaInline?: string | null;
/**
* [Deprecated] The format of the schemaInline property.
*/
schemaInlineFormat?: string | null;
/**
* Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
*/
schemaUpdateOptions?: string[] | null;
/**
* [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
*/
skipLeadingRows?: number | null;
/**
* [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
*/
sourceFormat?: string | null;
/**
* [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
*/
sourceUris?: string[] | null;
/**
* Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
*/
timePartitioning?: Schema$TimePartitioning;
/**
* [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
*/
useAvroLogicalTypes?: boolean | null;
/**
* [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
writeDisposition?: string | null;
}
export interface Schema$JobConfigurationQuery {
/**
* [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
*/
allowLargeResults?: boolean | null;
/**
* [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
*/
clustering?: Schema$Clustering;
/**
* [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
createDisposition?: string | null;
/**
* [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
*/
defaultDataset?: Schema$DatasetReference;
/**
* Custom encryption configuration (e.g., Cloud KMS keys).
*/
destinationEncryptionConfiguration?: Schema$EncryptionConfiguration;
/**
* [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
*/
destinationTable?: Schema$TableReference;
/**
* [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
*/
flattenResults?: boolean | null;
/**
* [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
*/
maximumBillingTier?: number | null;
/**
* [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
*/
maximumBytesBilled?: string | null;
/**
* Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
*/
parameterMode?: string | null;
/**
* [Deprecated] This property is deprecated.
*/
preserveNulls?: boolean | null;
/**
* [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
*/
priority?: string | null;
/**
* [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
*/
query?: string | null;
/**
* Query parameters for standard SQL queries.
*/
queryParameters?: Schema$QueryParameter[];
/**
* [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
*/
rangePartitioning?: Schema$RangePartitioning;
/**
* Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
*/
schemaUpdateOptions?: string[] | null;
/**
* [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
*/
tableDefinitions?: {
[key: string]: Schema$ExternalDataConfiguration;
} | null;
/**
* Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
*/
timePartitioning?: Schema$TimePartitioning;
/**
* Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
*/
useLegacySql?: boolean | null;
/**
* [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
*/
useQueryCache?: boolean | null;
/**
* Describes user-defined function resources used in the query.
*/
userDefinedFunctionResources?: Schema$UserDefinedFunctionResource[];
/**
* [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
writeDisposition?: string | null;
}
export interface Schema$JobConfigurationTableCopy {
/**
* [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
createDisposition?: string | null;
/**
* Custom encryption configuration (e.g., Cloud KMS keys).
*/
destinationEncryptionConfiguration?: Schema$EncryptionConfiguration;
/**
* [Required] The destination table
*/
destinationTable?: Schema$TableReference;
/**
* [Pick one] Source table to copy.
*/
sourceTable?: Schema$TableReference;
/**
* [Pick one] Source tables to copy.
*/
sourceTables?: Schema$TableReference[];
/**
* [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
writeDisposition?: string | null;
}
export interface Schema$JobList {
/**
* A hash of this page of results.
*/
etag?: string | null;
/**
* List of jobs that were requested.
*/
jobs?: Array<{
jobReference?: Schema$JobReference;
status?: Schema$JobStatus;
state?: string;
statistics?: Schema$JobStatistics;
id?: string;
configuration?: Schema$JobConfiguration;
user_email?: string;
errorResult?: Schema$ErrorProto;
kind?: string;
}> | null;
/**
* The resource type of the response.
*/
kind?: string | null;
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$JobReference {
/**
* [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
*/
jobId?: string | null;
/**
* The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string | null;
/**
* [Required] The ID of the project containing this job.
*/
projectId?: string | null;
}
export interface Schema$JobStatistics {
/**
* [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
*/
completionRatio?: number | null;
/**
* [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
*/
creationTime?: string | null;
/**
* [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
*/
endTime?: string | null;
/**
* [Output-only] Statistics for an extract job.
*/
extract?: Schema$JobStatistics4;
/**
* [Output-only] Statistics for a load job.
*/
load?: Schema$JobStatistics3;
/**
* [Output-only] Number of child jobs executed.
*/
numChildJobs?: string | null;
/**
* [Output-only] If this is a child job, the id of the parent.
*/
parentJobId?: string | null;
/**
* [Output-only] Statistics for a query job.
*/
query?: Schema$JobStatistics2;
/**
* [Output-only] Quotas which delayed this job's start time.
*/
quotaDeferments?: string[] | null;
/**
* [Output-only] Job resource usage breakdown by reservation.
*/
reservationUsage?: Array<{
slotMs?: string;
name?: string;
}> | null;
/**
* [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
*/
reservation_id?: string | null;
/**
* [Output-only] Statistics for a child job of a script.
*/
scriptStatistics?: Schema$ScriptStatistics;
/**
* [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
*/
startTime?: string | null;
/**
* [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
*/
totalBytesProcessed?: string | null;
/**
* [Output-only] Slot-milliseconds for the job.
*/
totalSlotMs?: string | null;
}
export interface Schema$JobStatistics2 {
/**
* [Output-only] Billing tier for the job.
*/
billingTier?: number | null;
/**
* [Output-only] Whether the query result was fetched from the query cache.
*/
cacheHit?: boolean | null;
/**
* The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
*/
ddlOperationPerformed?: string | null;
/**
* The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
*/
ddlTargetRoutine?: Schema$RoutineReference;
/**
* The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries.
*/
ddlTargetTable?: Schema$TableReference;
/**
* [Output-only] The original estimate of bytes processed for the job.
*/
estimatedBytesProcessed?: string | null;
/**
* [Output-only, Beta] Information about create model query job progress.
*/
modelTraining?: Schema$BigQueryModelTraining;
/**
* [Output-only, Beta] Deprecated; do not use.
*/
modelTrainingCurrentIteration?: number | null;
/**
* [Output-only, Beta] Deprecated; do not use.
*/
modelTrainingExpectedTotalIteration?: string | null;
/**
* [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
*/
numDmlAffectedRows?: string | null;
/**
* [Output-only] Describes execution plan for the query.
*/
queryPlan?: Schema$ExplainQueryStage[];
/**
* [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
*/
referencedRoutines?: Schema$RoutineReference[];
/**
* [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
*/
referencedTables?: Schema$TableReference[];
/**
* [Output-only] Job resource usage breakdown by reservation.
*/
reservationUsage?: Array<{
slotMs?: string;
name?: string;
}> | null;
/**
* [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
*/
schema?: Schema$TableSchema;
/**
* The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
*/
statementType?: string | null;
/**
* [Output-only] [Beta] Describes a timeline of job execution.
*/
timeline?: Schema$QueryTimelineSample[];
/**
* [Output-only] Total bytes billed for the job.
*/
totalBytesBilled?: string | null;
/**
* [Output-only] Total bytes processed for the job.
*/
totalBytesProcessed?: string | null;
/**
* [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
*/
totalBytesProcessedAccuracy?: string | null;
/**
* [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.
*/
totalPartitionsProcessed?: string | null;
/**
* [Output-only] Slot-milliseconds for the job.
*/
totalSlotMs?: string | null;
/**
* Standard SQL only: list of undeclared query parameters detected during a dry run validation.
*/
undeclaredQueryParameters?: Schema$QueryParameter[];
}
export interface Schema$JobStatistics3 {
/**
* [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
*/
badRecords?: string | null;
/**
* [Output-only] Number of bytes of source data in a load job.
*/
inputFileBytes?: string | null;
/**
* [Output-only] Number of source files in a load job.
*/
inputFiles?: string | null;
/**
* [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
*/
outputBytes?: string | null;
/**
* [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
*/
outputRows?: string | null;
}
export interface Schema$JobStatistics4 {
/**
* [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
*/
destinationUriFileCounts?: string[] | null;
/**
* [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
*/
inputBytes?: string | null;
}
export interface Schema$JobStatus {
/**
* [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
*/
errorResult?: Schema$ErrorProto;
/**
* [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
*/
errors?: Schema$ErrorProto[];
/**
* [Output-only] Running state of the job.
*/
state?: string | null;
}
/**
* Represents a single JSON object.
*/
export interface Schema$JsonObject {
}
export interface Schema$JsonValue {
}
export interface Schema$ListModelsResponse {
/**
* Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.
*/
models?: Schema$Model[];
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$ListRoutinesResponse {
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
/**
* Routines in the requested dataset. Only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, language.
*/
routines?: Schema$Routine[];
}
/**
* BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.
*/
export interface Schema$LocationMetadata {
/**
* The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations.
*/
legacyLocationId?: string | null;
}
export interface Schema$MaterializedViewDefinition {
/**
* [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
*/
lastRefreshTime?: string | null;
/**
* [Required] A query whose result is persisted.
*/
query?: string | null;
}
export interface Schema$Model {
/**
* Output only. The time when this model was created, in millisecs since the epoch.
*/
creationTime?: string | null;
/**
* Optional. A user-friendly description of this model.
*/
description?: string | null;
/**
* Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage.
*/
encryptionConfiguration?: Schema$EncryptionConfiguration;
/**
* Output only. A hash of this resource.
*/
etag?: string | null;
/**
* Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
*/
expirationTime?: string | null;
/**
* Output only. Input feature columns that were used to train this model.
*/
featureColumns?: Schema$StandardSqlField[];
/**
* Optional. A descriptive name for this model.
*/
friendlyName?: string | null;
/**
* Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
*/
labelColumns?: Schema$StandardSqlField[];
/**
* The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The time when this model was last modified, in millisecs since the epoch.
*/
lastModifiedTime?: string | null;
/**
* Output only. The geographic location where the model resides. This value is inherited from the dataset.
*/
location?: string | null;
/**
* Required. Unique identifier for this model.
*/
modelReference?: Schema$ModelReference;
/**
* Output only. Type of the model resource.
*/
modelType?: string | null;
/**
* Output only. Information for all training runs in increasing order of start_time.
*/
trainingRuns?: Schema$TrainingRun[];
}
export interface Schema$ModelDefinition {
/**
* [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.
*/
modelOptions?: {
labels?: string[];
lossType?: string;
modelType?: string;
} | null;
/**
* [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.
*/
trainingRuns?: Schema$BqmlTrainingRun[];
}
export interface Schema$ModelReference {
/**
* [Required] The ID of the dataset containing this model.
*/
datasetId?: string | null;
/**
* [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
*/
modelId?: string | null;
/**
* [Required] The ID of the project containing this model.
*/
projectId?: string | null;
}
/**
* Evaluation metrics for multi-class classification/classifier models.
*/
export interface Schema$MultiClassClassificationMetrics {
/**
* Aggregate classification metrics.
*/
aggregateClassificationMetrics?: Schema$AggregateClassificationMetrics;
/**
* Confusion matrix at different thresholds.
*/
confusionMatrixList?: Schema$ConfusionMatrix[];
}
export interface Schema$ProjectList {
/**
* A hash of the page of results
*/
etag?: string | null;
/**
* The type of list.
*/
kind?: string | null;
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
/**
* Projects to which you have at least READ access.
*/
projects?: Array<{
id?: string;
projectReference?: Schema$ProjectReference;
friendlyName?: string;
numericId?: string;
kind?: string;
}> | null;
/**
* The total number of projects in the list.
*/
totalItems?: number | null;
}
export interface Schema$ProjectReference {
/**
* [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.
*/
projectId?: string | null;
}
export interface Schema$QueryParameter {
/**
* [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
*/
name?: string | null;
/**
* [Required] The type of this parameter.
*/
parameterType?: Schema$QueryParameterType;
/**
* [Required] The value of this parameter.
*/
parameterValue?: Schema$QueryParameterValue;
}
export interface Schema$QueryParameterType {
/**
* [Optional] The type of the array's elements, if this is an array.
*/
arrayType?: Schema$QueryParameterType;
/**
* [Optional] The types of the fields of this struct, in order, if this is a struct.
*/
structTypes?: Array<{
type?: Schema$QueryParameterType;
name?: string;
description?: string;
}> | null;
/**
* [Required] The top level type of this field.
*/
type?: string | null;
}
export interface Schema$QueryParameterValue {
/**
* [Optional] The array values, if this is an array type.
*/
arrayValues?: Schema$QueryParameterValue[];
/**
* [Optional] The struct field values, in order of the struct type's declaration.
*/
structValues?: {
[key: string]: Schema$QueryParameterValue;
} | null;
/**
* [Optional] The value of this value, if a simple scalar type.
*/
value?: string | null;
}
export interface Schema$QueryRequest {
/**
* [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.
*/
defaultDataset?: Schema$DatasetReference;
/**
* [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.
*/
dryRun?: boolean | null;
/**
* The resource type of the request.
*/
kind?: string | null;
/**
* The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string | null;
/**
* [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.
*/
maxResults?: number | null;
/**
* Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
*/
parameterMode?: string | null;
/**
* [Deprecated] This property is deprecated.
*/
preserveNulls?: boolean | null;
/**
* [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".
*/
query?: string | null;
/**
* Query parameters for Standard SQL queries.
*/
queryParameters?: Schema$QueryParameter[];
/**
* [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).
*/
timeoutMs?: number | null;
/**
* Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
*/
useLegacySql?: boolean | null;
/**
* [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.
*/
useQueryCache?: boolean | null;
}
export interface Schema$QueryResponse {
/**
* Whether the query result was fetched from the query cache.
*/
cacheHit?: boolean | null;
/**
* [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
*/
errors?: Schema$ErrorProto[];
/**
* Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
*/
jobComplete?: boolean | null;
/**
* Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
*/
jobReference?: Schema$JobReference;
/**
* The resource type.
*/
kind?: string | null;
/**
* [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
*/
numDmlAffectedRows?: string | null;
/**
* A token used for paging results.
*/
pageToken?: string | null;
/**
* An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
*/
rows?: Schema$TableRow[];
/**
* The schema of the results. Present only when the query completes successfully.
*/
schema?: Schema$TableSchema;
/**
* The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.
*/
totalBytesProcessed?: string | null;
/**
* The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
*/
totalRows?: string | null;
}
export interface Schema$QueryTimelineSample {
/**
* Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
*/
activeUnits?: string | null;
/**
* Total parallel units of work completed by this query.
*/
completedUnits?: string | null;
/**
* Milliseconds elapsed since the start of query execution.
*/
elapsedMs?: string | null;
/**
* Total parallel units of work remaining for the active stages.
*/
pendingUnits?: string | null;
/**
* Cumulative slot-ms consumed by the query.
*/
totalSlotMs?: string | null;
}
export interface Schema$RangePartitioning {
/**
* [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
*/
field?: string | null;
/**
* [TrustedTester] [Required] Defines the ranges for range partitioning.
*/
range?: {
end?: string;
interval?: string;
start?: string;
} | null;
}
/**
* Evaluation metrics for regression and explicit feedback type matrix factorization models.
*/
export interface Schema$RegressionMetrics {
/**
* Mean absolute error.
*/
meanAbsoluteError?: number | null;
/**
* Mean squared error.
*/
meanSquaredError?: number | null;
/**
* Mean squared log error.
*/
meanSquaredLogError?: number | null;
/**
* Median absolute error.
*/
medianAbsoluteError?: number | null;
/**
* R^2 score.
*/
rSquared?: number | null;
}
/**
* A user-defined function or a stored procedure.
*/
export interface Schema$Routine {
/**
* Optional.
*/
arguments?: Schema$Argument[];
/**
* Output only. The time when this routine was created, in milliseconds since the epoch.
*/
creationTime?: string | null;
/**
* Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "x/", y))` The definition_body is `concat(x, "x/", y)` (x/ is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "x/";x/'` The definition_body is `return "x/";x/` Note that both x/ are replaced with linebreaks.
*/
definitionBody?: string | null;
/**
* Optional. [Experimental] The description of the routine if defined.
*/
description?: string | null;
/**
* Output only. A hash of this resource.
*/
etag?: string | null;
/**
* Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
*/
importedLibraries?: string[] | null;
/**
* Optional. Defaults to "SQL".
*/
language?: string | null;
/**
* Output only. The time when this routine was last modified, in milliseconds since the epoch.
*/
lastModifiedTime?: string | null;
/**
* Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64.
*/
returnType?: Schema$StandardSqlDataType;
/**
* Required. Reference describing the ID of this routine.
*/
routineReference?: Schema$RoutineReference;
/**
* Required. The type of routine.
*/
routineType?: string | null;
}
export interface Schema$RoutineReference {
/**
* [Required] The ID of the dataset containing this routine.
*/
datasetId?: string | null;
/**
* [Required] The ID of the project containing this routine.
*/
projectId?: string | null;
/**
* [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
*/
routineId?: string | null;
}
/**
* A single row in the confusion matrix.
*/
export interface Schema$Row {
/**
* The original label of this row.
*/
actualLabel?: string | null;
/**
* Info describing predicted label distribution.
*/
entries?: Schema$Entry[];
}
export interface Schema$ScriptStackFrame {
/**
* [Output-only] One-based end column.
*/
endColumn?: number | null;
/**
* [Output-only] One-based end line.
*/
endLine?: number | null;
/**
* [Output-only] Name of the active procedure, empty if in a top-level script.
*/
procedureId?: string | null;
/**
* [Output-only] One-based start column.
*/
startColumn?: number | null;
/**
* [Output-only] One-based start line.
*/
startLine?: number | null;
/**
* [Output-only] Text of the current statement/expression.
*/
text?: string | null;
}
export interface Schema$ScriptStatistics {
/**
* [Output-only] Whether this child job was a statement or expression.
*/
evaluationKind?: string | null;
/**
* Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
*/
stackFrames?: Schema$ScriptStackFrame[];
}
/**
* The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY<DATE>>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}
*/
export interface Schema$StandardSqlDataType {
/**
* The type of the array's elements, if type_kind = "ARRAY".
*/
arrayElementType?: Schema$StandardSqlDataType;
/**
* The fields of this struct, in order, if type_kind = "STRUCT".
*/
structType?: Schema$StandardSqlStructType;
/**
* Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
*/
typeKind?: string | null;
}
/**
* A field or a column.
*/
export interface Schema$StandardSqlField {
/**
* Optional. The name of this field. Can be absent for struct fields.
*/
name?: string | null;
/**
* Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
*/
type?: Schema$StandardSqlDataType;
}
export interface Schema$StandardSqlStructType {
fields?: Schema$StandardSqlField[];
}
export interface Schema$Streamingbuffer {
/**
* [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
*/
estimatedBytes?: string | null;
/**
* [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
*/
estimatedRows?: string | null;
/**
* [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
*/
oldestEntryTime?: string | null;
}
export interface Schema$Table {
/**
* [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.
*/
clustering?: Schema$Clustering;
/**
* [Output-only] The time when this table was created, in milliseconds since the epoch.
*/
creationTime?: string | null;
/**
* [Optional] A user-friendly description of this table.
*/
description?: string | null;
/**
* Custom encryption configuration (e.g., Cloud KMS keys).
*/
encryptionConfiguration?: Schema$EncryptionConfiguration;
/**
* [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.
*/
etag?: string | null;
/**
* [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.
*/
expirationTime?: string | null;
/**
* [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
*/
externalDataConfiguration?: Schema$ExternalDataConfiguration;
/**
* [Optional] A descriptive name for this table.
*/
friendlyName?: string | null;
/**
* [Output-only] An opaque ID uniquely identifying the table.
*/
id?: string | null;
/**
* [Output-only] The type of the resource.
*/
kind?: string | null;
/**
* The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
*/
labels?: {
[key: string]: string;
} | null;
/**
* [Output-only] The time when this table was last modified, in milliseconds since the epoch.
*/
lastModifiedTime?: string | null;
/**
* [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
*/
location?: string | null;
/**
* [Optional] Materialized view definition.
*/
materializedView?: Schema$MaterializedViewDefinition;
/**
* [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.
*/
model?: Schema$ModelDefinition;
/**
* [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
*/
numBytes?: string | null;
/**
* [Output-only] The number of bytes in the table that are considered "long-term storage".
*/
numLongTermBytes?: string | null;
/**
* [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.
*/
numPhysicalBytes?: string | null;
/**
* [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
*/
numRows?: string | null;
/**
* [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
*/
rangePartitioning?: Schema$RangePartitioning;
/**
* [Beta] [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
*/
requirePartitionFilter?: boolean | null;
/**
* [Optional] Describes the schema of this table.
*/
schema?: Schema$TableSchema;
/**
* [Output-only] A URL that can be used to access this resource again.
*/
selfLink?: string | null;
/**
* [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
*/
streamingBuffer?: Schema$Streamingbuffer;
/**
* [Required] Reference describing the ID of this table.
*/
tableReference?: Schema$TableReference;
/**
* Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
*/
timePartitioning?: Schema$TimePartitioning;
/**
* [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
*/
type?: string | null;
/**
* [Optional] The view definition.
*/
view?: Schema$ViewDefinition;
}
export interface Schema$TableCell {
v?: any | null;
}
export interface Schema$TableDataInsertAllRequest {
/**
* [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
*/
ignoreUnknownValues?: boolean | null;
/**
* The resource type of the response.
*/
kind?: string | null;
/**
* The rows to insert.
*/
rows?: Array<{
insertId?: string;
json?: Schema$JsonObject;
}> | null;
/**
* [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
*/
skipInvalidRows?: boolean | null;
/**
* If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
*/
templateSuffix?: string | null;
}
export interface Schema$TableDataInsertAllResponse {
/**
* An array of errors for rows that were not inserted.
*/
insertErrors?: Array<{
errors?: Schema$ErrorProto[];
index?: number;
}> | null;
/**
* The resource type of the response.
*/
kind?: string | null;
}
export interface Schema$TableDataList {
/**
* A hash of this page of results.
*/
etag?: string | null;
/**
* The resource type of the response.
*/
kind?: string | null;
/**
* A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.
*/
pageToken?: string | null;
/**
* Rows of results.
*/
rows?: Schema$TableRow[];
/**
* The total number of rows in the complete table.
*/
totalRows?: string | null;
}
export interface Schema$TableFieldSchema {
/**
* [Optional] The categories attached to this field, used for field-level access control.
*/
categories?: {
names?: string[];
} | null;
/**
* [Optional] The field description. The maximum length is 1,024 characters.
*/
description?: string | null;
/**
* [Optional] Describes the nested schema fields if the type property is set to RECORD.
*/
fields?: Schema$TableFieldSchema[];
/**
* [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
*/
mode?: string | null;
/**
* [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
*/
name?: string | null;
/**
* [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
*/
type?: string | null;
}
export interface Schema$TableList {
/**
* A hash of this page of results.
*/
etag?: string | null;
/**
* The type of list.
*/
kind?: string | null;
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
/**
* Tables in the requested dataset.
*/
tables?: Array<{
creationTime?: string;
rangePartitioning?: Schema$RangePartitioning;
id?: string;
tableReference?: Schema$TableReference;
timePartitioning?: Schema$TimePartitioning;
friendlyName?: string;
labels?: {
[key: string]: string;
};
type?: string;
clustering?: Schema$Clustering;
expirationTime?: string;
kind?: string;
view?: {
useLegacySql?: boolean;
};
}> | null;
/**
* The total number of tables in the dataset.
*/
totalItems?: number | null;
}
export interface Schema$TableReference {
/**
* [Required] The ID of the dataset containing this table.
*/
datasetId?: string | null;
/**
* [Required] The ID of the project containing this table.
*/
projectId?: string | null;
/**
* [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
*/
tableId?: string | null;
}
export interface Schema$TableRow {
/**
* Represents a single row in the result set, consisting of one or more fields.
*/
f?: Schema$TableCell[];
}
export interface Schema$TableSchema {
/**
* Describes the fields in a table.
*/
fields?: Schema$TableFieldSchema[];
}
export interface Schema$TimePartitioning {
/**
* [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
*/
expirationMs?: string | null;
/**
* [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
*/
field?: string | null;
requirePartitionFilter?: boolean | null;
/**
* [Required] The only type supported is DAY, which will generate one partition per day.
*/
type?: string | null;
}
export interface Schema$TrainingOptions {
/**
* The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
*/
dataSplitColumn?: string | null;
/**
* The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
*/
dataSplitEvalFraction?: number | null;
/**
* The data split type for training and evaluation, e.g. RANDOM.
*/
dataSplitMethod?: string | null;
/**
* Distance type for clustering models.
*/
distanceType?: string | null;
/**
* Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.
*/
earlyStop?: boolean | null;
/**
* Specifies the initial learning rate for the line search learn rate strategy.
*/
initialLearnRate?: number | null;
/**
* Name of input label columns in training data.
*/
inputLabelColumns?: string[] | null;
/**
* The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
*/
kmeansInitializationColumn?: string | null;
/**
* The method used to initialize the centroids for kmeans algorithm.
*/
kmeansInitializationMethod?: string | null;
/**
* L1 regularization coefficient.
*/
l1Regularization?: number | null;
/**
* L2 regularization coefficient.
*/
l2Regularization?: number | null;
/**
* Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
*/
labelClassWeights?: {
[key: string]: number;
} | null;
/**
* Learning rate in training. Used only for iterative training algorithms.
*/
learnRate?: number | null;
/**
* The strategy to determine learn rate for the current iteration.
*/
learnRateStrategy?: string | null;
/**
* Type of loss function used during training run.
*/
lossType?: string | null;
/**
* The maximum number of iterations in training. Used only for iterative training algorithms.
*/
maxIterations?: string | null;
/**
* When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
*/
minRelativeProgress?: number | null;
/**
* [Beta] Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
*/
modelUri?: string | null;
/**
* Number of clusters for clustering models.
*/
numClusters?: string | null;
/**
* Optimization strategy for training linear regression models.
*/
optimizationStrategy?: string | null;
/**
* Whether to train a model from the last checkpoint.
*/
warmStart?: boolean | null;
}
/**
* Information about a single training query run for the model.
*/
export interface Schema$TrainingRun {
/**
* The evaluation metrics over training/eval data that were computed at the end of training.
*/
evaluationMetrics?: Schema$EvaluationMetrics;
/**
* Output of each iteration run, results.size() <= max_iterations.
*/
results?: Schema$IterationResult[];
/**
* The start time of this training run.
*/
startTime?: string | null;
/**
* Options that were used for this training run, includes user specified and default options that were used.
*/
trainingOptions?: Schema$TrainingOptions;
}
export interface Schema$UserDefinedFunctionResource {
/**
* [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
*/
inlineCode?: string | null;
/**
* [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
*/
resourceUri?: string | null;
}
export interface Schema$ViewDefinition {
/**
* [Required] A query that BigQuery executes when the view is referenced.
*/
query?: string | null;
/**
* Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
*/
useLegacySql?: boolean | null;
/**
* Describes user-defined function resources used in the query.
*/
userDefinedFunctionResources?: Schema$UserDefinedFunctionResource[];
}
export class Resource$Datasets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquery.datasets.delete
* @desc Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the dataset being deleted
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of dataset being deleted
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.datasets.delete(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.datasets.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of dataset being deleted
* @param {boolean=} params.deleteContents If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
* @param {string} params.projectId Project ID of the dataset being deleted
* @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$Datasets$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Datasets$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Datasets$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* bigquery.datasets.get
* @desc Returns the dataset specified by datasetID.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the requested dataset
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the requested dataset
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.datasets.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.datasets.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the requested dataset
* @param {string} params.projectId Project ID of the requested dataset
* @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$Datasets$Get, options?: MethodOptions): GaxiosPromise<Schema$Dataset>;
get(params: Params$Resource$Datasets$Get, options: MethodOptions | BodyResponseCallback<Schema$Dataset>, callback: BodyResponseCallback<Schema$Dataset>): void;
get(params: Params$Resource$Datasets$Get, callback: BodyResponseCallback<Schema$Dataset>): void;
get(callback: BodyResponseCallback<Schema$Dataset>): void;
/**
* bigquery.datasets.insert
* @desc Creates a new empty dataset.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the new dataset
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* bigquery.datasets.insert(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.datasets.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId Project ID of the new dataset
* @param {().Dataset} 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
*/
insert(params?: Params$Resource$Datasets$Insert, options?: MethodOptions): GaxiosPromise<Schema$Dataset>;
insert(params: Params$Resource$Datasets$Insert, options: MethodOptions | BodyResponseCallback<Schema$Dataset>, callback: BodyResponseCallback<Schema$Dataset>): void;
insert(params: Params$Resource$Datasets$Insert, callback: BodyResponseCallback<Schema$Dataset>): void;
insert(callback: BodyResponseCallback<Schema$Dataset>): void;
/**
* bigquery.datasets.list
* @desc Lists all datasets in the specified project to which you have been granted the READER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the datasets to be listed
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var datasetsPage = response['datasets'];
* if (!datasetsPage) {
* return;
* }
* for (var i = 0; i < datasetsPage.length; i++) {
* // TODO: Change code below to process each resource in `datasetsPage`:
* console.log(JSON.stringify(datasetsPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* bigquery.datasets.list(request, handlePage);
* }
* };
*
* bigquery.datasets.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.datasets.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.all Whether to list all datasets, including hidden ones
* @param {string=} params.filter An expression for filtering the results of the request by label. The syntax is "labels.<name>[:<value>]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
* @param {integer=} params.maxResults The maximum number of results to return
* @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results
* @param {string} params.projectId Project ID of the datasets to be listed
* @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$Datasets$List, options?: MethodOptions): GaxiosPromise<Schema$DatasetList>;
list(params: Params$Resource$Datasets$List, options: MethodOptions | BodyResponseCallback<Schema$DatasetList>, callback: BodyResponseCallback<Schema$DatasetList>): void;
list(params: Params$Resource$Datasets$List, callback: BodyResponseCallback<Schema$DatasetList>): void;
list(callback: BodyResponseCallback<Schema$DatasetList>): void;
/**
* bigquery.datasets.patch
* @desc Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the dataset being updated
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the dataset being updated
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. Only these properties
* // will be changed.
* },
*
* auth: authClient,
* };
*
* bigquery.datasets.patch(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.datasets.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the dataset being updated
* @param {string} params.projectId Project ID of the dataset being updated
* @param {().Dataset} 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$Datasets$Patch, options?: MethodOptions): GaxiosPromise<Schema$Dataset>;
patch(params: Params$Resource$Datasets$Patch, options: MethodOptions | BodyResponseCallback<Schema$Dataset>, callback: BodyResponseCallback<Schema$Dataset>): void;
patch(params: Params$Resource$Datasets$Patch, callback: BodyResponseCallback<Schema$Dataset>): void;
patch(callback: BodyResponseCallback<Schema$Dataset>): void;
/**
* bigquery.datasets.update
* @desc Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the dataset being updated
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the dataset being updated
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. All existing properties
* // will be replaced.
* },
*
* auth: authClient,
* };
*
* bigquery.datasets.update(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.datasets.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the dataset being updated
* @param {string} params.projectId Project ID of the dataset being updated
* @param {().Dataset} 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
*/
update(params?: Params$Resource$Datasets$Update, options?: MethodOptions): GaxiosPromise<Schema$Dataset>;
update(params: Params$Resource$Datasets$Update, options: MethodOptions | BodyResponseCallback<Schema$Dataset>, callback: BodyResponseCallback<Schema$Dataset>): void;
update(params: Params$Resource$Datasets$Update, callback: BodyResponseCallback<Schema$Dataset>): void;
update(callback: BodyResponseCallback<Schema$Dataset>): void;
}
export interface Params$Resource$Datasets$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of dataset being deleted
*/
datasetId?: string;
/**
* If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
*/
deleteContents?: boolean;
/**
* Project ID of the dataset being deleted
*/
projectId?: string;
}
export interface Params$Resource$Datasets$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the requested dataset
*/
datasetId?: string;
/**
* Project ID of the requested dataset
*/
projectId?: string;
}
export interface Params$Resource$Datasets$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Project ID of the new dataset
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Dataset;
}
export interface Params$Resource$Datasets$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to list all datasets, including hidden ones
*/
all?: boolean;
/**
* An expression for filtering the results of the request by label. The syntax is "labels.<name>[:<value>]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
*/
filter?: string;
/**
* The maximum number of results to return
*/
maxResults?: number;
/**
* Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
* Project ID of the datasets to be listed
*/
projectId?: string;
}
export interface Params$Resource$Datasets$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the dataset being updated
*/
datasetId?: string;
/**
* Project ID of the dataset being updated
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Dataset;
}
export interface Params$Resource$Datasets$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the dataset being updated
*/
datasetId?: string;
/**
* Project ID of the dataset being updated
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Dataset;
}
export class Resource$Jobs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquery.jobs.cancel
* @desc Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // [Required] Project ID of the job to cancel
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // [Required] Job ID of the job to cancel
* jobId: 'my-job-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.jobs.cancel(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.jobs.cancel
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.jobId [Required] Job ID of the job to cancel
* @param {string=} params.location The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
* @param {string} params.projectId [Required] Project ID of the job to cancel
* @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
*/
cancel(params?: Params$Resource$Jobs$Cancel, options?: MethodOptions): GaxiosPromise<Schema$JobCancelResponse>;
cancel(params: Params$Resource$Jobs$Cancel, options: MethodOptions | BodyResponseCallback<Schema$JobCancelResponse>, callback: BodyResponseCallback<Schema$JobCancelResponse>): void;
cancel(params: Params$Resource$Jobs$Cancel, callback: BodyResponseCallback<Schema$JobCancelResponse>): void;
cancel(callback: BodyResponseCallback<Schema$JobCancelResponse>): void;
/**
* bigquery.jobs.get
* @desc Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // [Required] Project ID of the requested job
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // [Required] Job ID of the requested job
* jobId: 'my-job-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.jobs.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.jobs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.jobId [Required] Job ID of the requested job
* @param {string=} params.location The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
* @param {string} params.projectId [Required] Project ID of the requested job
* @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$Jobs$Get, options?: MethodOptions): GaxiosPromise<Schema$Job>;
get(params: Params$Resource$Jobs$Get, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
get(params: Params$Resource$Jobs$Get, callback: BodyResponseCallback<Schema$Job>): void;
get(callback: BodyResponseCallback<Schema$Job>): void;
/**
* bigquery.jobs.getQueryResults
* @desc Retrieves the results of a query job.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // [Required] Project ID of the query job
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // [Required] Job ID of the query job
* jobId: 'my-job-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var errorsPage = response['errors'];
* if (!errorsPage) {
* return;
* }
* for (var i = 0; i < errorsPage.length; i++) {
* // TODO: Change code below to process each resource in `errorsPage`:
* console.log(JSON.stringify(errorsPage[i], null, 2));
* }
*
* if (response.pageToken) {
* request.pageToken = response.pageToken;
* bigquery.jobs.getQueryResults(request, handlePage);
* }
* };
*
* bigquery.jobs.getQueryResults(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.jobs.getQueryResults
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.jobId [Required] Job ID of the query job
* @param {string=} params.location The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
* @param {integer=} params.maxResults Maximum number of results to read
* @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results
* @param {string} params.projectId [Required] Project ID of the query job
* @param {string=} params.startIndex Zero-based index of the starting row
* @param {integer=} params.timeoutMs How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false
* @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
*/
getQueryResults(params?: Params$Resource$Jobs$Getqueryresults, options?: MethodOptions): GaxiosPromise<Schema$GetQueryResultsResponse>;
getQueryResults(params: Params$Resource$Jobs$Getqueryresults, options: MethodOptions | BodyResponseCallback<Schema$GetQueryResultsResponse>, callback: BodyResponseCallback<Schema$GetQueryResultsResponse>): void;
getQueryResults(params: Params$Resource$Jobs$Getqueryresults, callback: BodyResponseCallback<Schema$GetQueryResultsResponse>): void;
getQueryResults(callback: BodyResponseCallback<Schema$GetQueryResultsResponse>): void;
/**
* bigquery.jobs.insert
* @desc Starts a new asynchronous job. Requires the Can View project role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the project that will be billed for the job
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* media: {
* // TODO: Add desired media content for upload. See
* // https://github.com/google/google-api-nodejs-client#media-uploads
* mimeType: '', // See https://www.w3.org/Protocols/rfc1341/4_Content-Type.html
* body: '',
* },
*
* auth: authClient,
* };
*
* bigquery.jobs.insert(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.jobs.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId Project ID of the project that will be billed for the job
* @param {object} params.resource Media resource metadata
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @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
*/
insert(params?: Params$Resource$Jobs$Insert, options?: MethodOptions): GaxiosPromise<Schema$Job>;
insert(params: Params$Resource$Jobs$Insert, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
insert(params: Params$Resource$Jobs$Insert, callback: BodyResponseCallback<Schema$Job>): void;
insert(callback: BodyResponseCallback<Schema$Job>): void;
/**
* bigquery.jobs.list
* @desc Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the jobs to list
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var jobsPage = response['jobs'];
* if (!jobsPage) {
* return;
* }
* for (var i = 0; i < jobsPage.length; i++) {
* // TODO: Change code below to process each resource in `jobsPage`:
* console.log(JSON.stringify(jobsPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* bigquery.jobs.list(request, handlePage);
* }
* };
*
* bigquery.jobs.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.jobs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.allUsers Whether to display jobs owned by all users in the project. Default false
* @param {string=} params.maxCreationTime Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string=} params.minCreationTime Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned
* @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results
* @param {string=} params.parentJobId If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent
* @param {string} params.projectId Project ID of the jobs to list
* @param {string=} params.projection Restrict information returned to a set of selected fields
* @param {string=} params.stateFilter Filter for job state
* @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$Jobs$List, options?: MethodOptions): GaxiosPromise<Schema$JobList>;
list(params: Params$Resource$Jobs$List, options: MethodOptions | BodyResponseCallback<Schema$JobList>, callback: BodyResponseCallback<Schema$JobList>): void;
list(params: Params$Resource$Jobs$List, callback: BodyResponseCallback<Schema$JobList>): void;
list(callback: BodyResponseCallback<Schema$JobList>): void;
/**
* bigquery.jobs.query
* @desc Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the project billed for the query
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* bigquery.jobs.query(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.jobs.query
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId Project ID of the project billed for the query
* @param {().QueryRequest} 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
*/
query(params?: Params$Resource$Jobs$Query, options?: MethodOptions): GaxiosPromise<Schema$QueryResponse>;
query(params: Params$Resource$Jobs$Query, options: MethodOptions | BodyResponseCallback<Schema$QueryResponse>, callback: BodyResponseCallback<Schema$QueryResponse>): void;
query(params: Params$Resource$Jobs$Query, callback: BodyResponseCallback<Schema$QueryResponse>): void;
query(callback: BodyResponseCallback<Schema$QueryResponse>): void;
}
export interface Params$Resource$Jobs$Cancel extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* [Required] Job ID of the job to cancel
*/
jobId?: string;
/**
* The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string;
/**
* [Required] Project ID of the job to cancel
*/
projectId?: string;
}
export interface Params$Resource$Jobs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* [Required] Job ID of the requested job
*/
jobId?: string;
/**
* The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string;
/**
* [Required] Project ID of the requested job
*/
projectId?: string;
}
export interface Params$Resource$Jobs$Getqueryresults extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* [Required] Job ID of the query job
*/
jobId?: string;
/**
* The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string;
/**
* Maximum number of results to read
*/
maxResults?: number;
/**
* Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
* [Required] Project ID of the query job
*/
projectId?: string;
/**
* Zero-based index of the starting row
*/
startIndex?: string;
/**
* How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false
*/
timeoutMs?: number;
}
export interface Params$Resource$Jobs$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Project ID of the project that will be billed for the job
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Job;
/**
* Media metadata
*/
media?: {
/**
* Media mime-type
*/
mimeType?: string;
/**
* Media body contents
*/
body?: any;
};
}
export interface Params$Resource$Jobs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to display jobs owned by all users in the project. Default false
*/
allUsers?: boolean;
/**
* Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned
*/
maxCreationTime?: string;
/**
* Maximum number of results to return
*/
maxResults?: number;
/**
* Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned
*/
minCreationTime?: string;
/**
* Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
* If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent
*/
parentJobId?: string;
/**
* Project ID of the jobs to list
*/
projectId?: string;
/**
* Restrict information returned to a set of selected fields
*/
projection?: string;
/**
* Filter for job state
*/
stateFilter?: string[];
}
export interface Params$Resource$Jobs$Query extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Project ID of the project billed for the query
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$QueryRequest;
}
export class Resource$Models {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquery.models.delete
* @desc Deletes the model specified by modelId from the dataset.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the model to delete.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the model to delete.
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Model ID of the model to delete.
* modelId: 'my-model-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.models.delete(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.models.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the model to delete.
* @param {string} params.modelId Required. Model ID of the model to delete.
* @param {string} params.projectId Required. Project ID of the model to delete.
* @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$Models$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Models$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Models$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* bigquery.models.get
* @desc Gets the specified model resource by model ID.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the requested model.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the requested model.
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Model ID of the requested model.
* modelId: 'my-model-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.models.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.models.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the requested model.
* @param {string} params.modelId Required. Model ID of the requested model.
* @param {string} params.projectId Required. Project ID of the requested model.
* @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$Models$Get, options?: MethodOptions): GaxiosPromise<Schema$Model>;
get(params: Params$Resource$Models$Get, options: MethodOptions | BodyResponseCallback<Schema$Model>, callback: BodyResponseCallback<Schema$Model>): void;
get(params: Params$Resource$Models$Get, callback: BodyResponseCallback<Schema$Model>): void;
get(callback: BodyResponseCallback<Schema$Model>): void;
/**
* bigquery.models.list
* @desc Lists all models in the specified dataset. Requires the READER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the models to list.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the models to list.
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var modelsPage = response['models'];
* if (!modelsPage) {
* return;
* }
* for (var i = 0; i < modelsPage.length; i++) {
* // TODO: Change code below to process each resource in `modelsPage`:
* console.log(JSON.stringify(modelsPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* bigquery.models.list(request, handlePage);
* }
* };
*
* bigquery.models.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.models.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the models to list.
* @param {integer=} params.maxResults The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
* @param {string=} params.pageToken Page token, returned by a previous call to request the next page of results
* @param {string} params.projectId Required. Project ID of the models to list.
* @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$Models$List, options?: MethodOptions): GaxiosPromise<Schema$ListModelsResponse>;
list(params: Params$Resource$Models$List, options: MethodOptions | BodyResponseCallback<Schema$ListModelsResponse>, callback: BodyResponseCallback<Schema$ListModelsResponse>): void;
list(params: Params$Resource$Models$List, callback: BodyResponseCallback<Schema$ListModelsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListModelsResponse>): void;
/**
* bigquery.models.patch
* @desc Patch specific fields in the specified model.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the model to patch.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the model to patch.
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Model ID of the model to patch.
* modelId: 'my-model-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. Only these properties
* // will be changed.
* },
*
* auth: authClient,
* };
*
* bigquery.models.patch(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.models.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the model to patch.
* @param {string} params.modelId Required. Model ID of the model to patch.
* @param {string} params.projectId Required. Project ID of the model to patch.
* @param {().Model} 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$Models$Patch, options?: MethodOptions): GaxiosPromise<Schema$Model>;
patch(params: Params$Resource$Models$Patch, options: MethodOptions | BodyResponseCallback<Schema$Model>, callback: BodyResponseCallback<Schema$Model>): void;
patch(params: Params$Resource$Models$Patch, callback: BodyResponseCallback<Schema$Model>): void;
patch(callback: BodyResponseCallback<Schema$Model>): void;
}
export interface Params$Resource$Models$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the model to delete.
*/
datasetId?: string;
/**
* Required. Model ID of the model to delete.
*/
modelId?: string;
/**
* Required. Project ID of the model to delete.
*/
projectId?: string;
}
export interface Params$Resource$Models$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the requested model.
*/
datasetId?: string;
/**
* Required. Model ID of the requested model.
*/
modelId?: string;
/**
* Required. Project ID of the requested model.
*/
projectId?: string;
}
export interface Params$Resource$Models$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the models to list.
*/
datasetId?: string;
/**
* The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
*/
maxResults?: number;
/**
* Page token, returned by a previous call to request the next page of results
*/
pageToken?: string;
/**
* Required. Project ID of the models to list.
*/
projectId?: string;
}
export interface Params$Resource$Models$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the model to patch.
*/
datasetId?: string;
/**
* Required. Model ID of the model to patch.
*/
modelId?: string;
/**
* Required. Project ID of the model to patch.
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Model;
}
export class Resource$Projects {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquery.projects.getServiceAccount
* @desc Returns the email address of the service account for your project used for interactions with Google Cloud KMS.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID for which the service account is requested.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.projects.getServiceAccount(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.projects.getServiceAccount
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId Project ID for which the service account is requested.
* @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
*/
getServiceAccount(params?: Params$Resource$Projects$Getserviceaccount, options?: MethodOptions): GaxiosPromise<Schema$GetServiceAccountResponse>;
getServiceAccount(params: Params$Resource$Projects$Getserviceaccount, options: MethodOptions | BodyResponseCallback<Schema$GetServiceAccountResponse>, callback: BodyResponseCallback<Schema$GetServiceAccountResponse>): void;
getServiceAccount(params: Params$Resource$Projects$Getserviceaccount, callback: BodyResponseCallback<Schema$GetServiceAccountResponse>): void;
getServiceAccount(callback: BodyResponseCallback<Schema$GetServiceAccountResponse>): void;
/**
* bigquery.projects.list
* @desc Lists all projects to which you have been granted any project role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var projectsPage = response['projects'];
* if (!projectsPage) {
* return;
* }
* for (var i = 0; i < projectsPage.length; i++) {
* // TODO: Change code below to process each resource in `projectsPage`:
* console.log(JSON.stringify(projectsPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* bigquery.projects.list(request, handlePage);
* }
* };
*
* bigquery.projects.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.projects.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results
* @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$List, options?: MethodOptions): GaxiosPromise<Schema$ProjectList>;
list(params: Params$Resource$Projects$List, options: MethodOptions | BodyResponseCallback<Schema$ProjectList>, callback: BodyResponseCallback<Schema$ProjectList>): void;
list(params: Params$Resource$Projects$List, callback: BodyResponseCallback<Schema$ProjectList>): void;
list(callback: BodyResponseCallback<Schema$ProjectList>): void;
}
export interface Params$Resource$Projects$Getserviceaccount extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Project ID for which the service account is requested.
*/
projectId?: string;
}
export interface Params$Resource$Projects$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of results to return
*/
maxResults?: number;
/**
* Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
}
export class Resource$Routines {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquery.routines.delete
* @desc Deletes the routine specified by routineId from the dataset.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the routine to delete
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the routine to delete
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Routine ID of the routine to delete
* routineId: 'my-routine-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.routines.delete(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.routines.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the routine to delete
* @param {string} params.projectId Required. Project ID of the routine to delete
* @param {string} params.routineId Required. Routine ID of the routine to delete
* @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$Routines$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Routines$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Routines$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* bigquery.routines.get
* @desc Gets the specified routine resource by routine ID.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the requested routine
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the requested routine
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Routine ID of the requested routine
* routineId: 'my-routine-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.routines.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.routines.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the requested routine
* @param {string=} params.fieldMask If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.
* @param {string} params.projectId Required. Project ID of the requested routine
* @param {string} params.routineId Required. Routine ID of the requested routine
* @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$Routines$Get, options?: MethodOptions): GaxiosPromise<Schema$Routine>;
get(params: Params$Resource$Routines$Get, options: MethodOptions | BodyResponseCallback<Schema$Routine>, callback: BodyResponseCallback<Schema$Routine>): void;
get(params: Params$Resource$Routines$Get, callback: BodyResponseCallback<Schema$Routine>): void;
get(callback: BodyResponseCallback<Schema$Routine>): void;
/**
* bigquery.routines.insert
* @desc Creates a new routine in the dataset.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the new routine
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the new routine
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* bigquery.routines.insert(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.routines.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the new routine
* @param {string} params.projectId Required. Project ID of the new routine
* @param {().Routine} 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
*/
insert(params?: Params$Resource$Routines$Insert, options?: MethodOptions): GaxiosPromise<Schema$Routine>;
insert(params: Params$Resource$Routines$Insert, options: MethodOptions | BodyResponseCallback<Schema$Routine>, callback: BodyResponseCallback<Schema$Routine>): void;
insert(params: Params$Resource$Routines$Insert, callback: BodyResponseCallback<Schema$Routine>): void;
insert(callback: BodyResponseCallback<Schema$Routine>): void;
/**
* bigquery.routines.list
* @desc Lists all routines in the specified dataset. Requires the READER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the routines to list
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the routines to list
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var routinesPage = response['routines'];
* if (!routinesPage) {
* return;
* }
* for (var i = 0; i < routinesPage.length; i++) {
* // TODO: Change code below to process each resource in `routinesPage`:
* console.log(JSON.stringify(routinesPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* bigquery.routines.list(request, handlePage);
* }
* };
*
* bigquery.routines.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.routines.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the routines to list
* @param {integer=} params.maxResults The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
* @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results
* @param {string} params.projectId Required. Project ID of the routines to list
* @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$Routines$List, options?: MethodOptions): GaxiosPromise<Schema$ListRoutinesResponse>;
list(params: Params$Resource$Routines$List, options: MethodOptions | BodyResponseCallback<Schema$ListRoutinesResponse>, callback: BodyResponseCallback<Schema$ListRoutinesResponse>): void;
list(params: Params$Resource$Routines$List, callback: BodyResponseCallback<Schema$ListRoutinesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListRoutinesResponse>): void;
/**
* bigquery.routines.update
* @desc Updates information in an existing routine. The update method replaces the entire Routine resource.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the routine to update
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the routine to update
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Routine ID of the routine to update
* routineId: 'my-routine-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. All existing properties
* // will be replaced.
* },
*
* auth: authClient,
* };
*
* bigquery.routines.update(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.routines.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Required. Dataset ID of the routine to update
* @param {string} params.projectId Required. Project ID of the routine to update
* @param {string} params.routineId Required. Routine ID of the routine to update
* @param {().Routine} 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
*/
update(params?: Params$Resource$Routines$Update, options?: MethodOptions): GaxiosPromise<Schema$Routine>;
update(params: Params$Resource$Routines$Update, options: MethodOptions | BodyResponseCallback<Schema$Routine>, callback: BodyResponseCallback<Schema$Routine>): void;
update(params: Params$Resource$Routines$Update, callback: BodyResponseCallback<Schema$Routine>): void;
update(callback: BodyResponseCallback<Schema$Routine>): void;
}
export interface Params$Resource$Routines$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the routine to delete
*/
datasetId?: string;
/**
* Required. Project ID of the routine to delete
*/
projectId?: string;
/**
* Required. Routine ID of the routine to delete
*/
routineId?: string;
}
export interface Params$Resource$Routines$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the requested routine
*/
datasetId?: string;
/**
* If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.
*/
fieldMask?: string;
/**
* Required. Project ID of the requested routine
*/
projectId?: string;
/**
* Required. Routine ID of the requested routine
*/
routineId?: string;
}
export interface Params$Resource$Routines$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the new routine
*/
datasetId?: string;
/**
* Required. Project ID of the new routine
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Routine;
}
export interface Params$Resource$Routines$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the routines to list
*/
datasetId?: string;
/**
* The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
*/
maxResults?: number;
/**
* Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
* Required. Project ID of the routines to list
*/
projectId?: string;
}
export interface Params$Resource$Routines$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Dataset ID of the routine to update
*/
datasetId?: string;
/**
* Required. Project ID of the routine to update
*/
projectId?: string;
/**
* Required. Routine ID of the routine to update
*/
routineId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Routine;
}
export class Resource$Tabledata {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquery.tabledata.insertAll
* @desc Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the destination table.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the destination table.
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Table ID of the destination table.
* tableId: 'my-table-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* bigquery.tabledata.insertAll(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.tabledata.insertAll
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the destination table.
* @param {string} params.projectId Project ID of the destination table.
* @param {string} params.tableId Table ID of the destination table.
* @param {().TableDataInsertAllRequest} 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
*/
insertAll(params?: Params$Resource$Tabledata$Insertall, options?: MethodOptions): GaxiosPromise<Schema$TableDataInsertAllResponse>;
insertAll(params: Params$Resource$Tabledata$Insertall, options: MethodOptions | BodyResponseCallback<Schema$TableDataInsertAllResponse>, callback: BodyResponseCallback<Schema$TableDataInsertAllResponse>): void;
insertAll(params: Params$Resource$Tabledata$Insertall, callback: BodyResponseCallback<Schema$TableDataInsertAllResponse>): void;
insertAll(callback: BodyResponseCallback<Schema$TableDataInsertAllResponse>): void;
/**
* bigquery.tabledata.list
* @desc Retrieves table data from a specified set of rows. Requires the READER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the table to read
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the table to read
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Table ID of the table to read
* tableId: 'my-table-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var rowsPage = response['rows'];
* if (!rowsPage) {
* return;
* }
* for (var i = 0; i < rowsPage.length; i++) {
* // TODO: Change code below to process each resource in `rowsPage`:
* console.log(JSON.stringify(rowsPage[i], null, 2));
* }
*
* if (response.pageToken) {
* request.pageToken = response.pageToken;
* bigquery.tabledata.list(request, handlePage);
* }
* };
*
* bigquery.tabledata.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.tabledata.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the table to read
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string=} params.pageToken Page token, returned by a previous call, identifying the result set
* @param {string} params.projectId Project ID of the table to read
* @param {string=} params.selectedFields List of fields to return (comma-separated). If unspecified, all fields are returned
* @param {string=} params.startIndex Zero-based index of the starting row to read
* @param {string} params.tableId Table ID of the table to read
* @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$Tabledata$List, options?: MethodOptions): GaxiosPromise<Schema$TableDataList>;
list(params: Params$Resource$Tabledata$List, options: MethodOptions | BodyResponseCallback<Schema$TableDataList>, callback: BodyResponseCallback<Schema$TableDataList>): void;
list(params: Params$Resource$Tabledata$List, callback: BodyResponseCallback<Schema$TableDataList>): void;
list(callback: BodyResponseCallback<Schema$TableDataList>): void;
}
export interface Params$Resource$Tabledata$Insertall extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the destination table.
*/
datasetId?: string;
/**
* Project ID of the destination table.
*/
projectId?: string;
/**
* Table ID of the destination table.
*/
tableId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TableDataInsertAllRequest;
}
export interface Params$Resource$Tabledata$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the table to read
*/
datasetId?: string;
/**
* Maximum number of results to return
*/
maxResults?: number;
/**
* Page token, returned by a previous call, identifying the result set
*/
pageToken?: string;
/**
* Project ID of the table to read
*/
projectId?: string;
/**
* List of fields to return (comma-separated). If unspecified, all fields are returned
*/
selectedFields?: string;
/**
* Zero-based index of the starting row to read
*/
startIndex?: string;
/**
* Table ID of the table to read
*/
tableId?: string;
}
export class Resource$Tables {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigquery.tables.delete
* @desc Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the table to delete
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the table to delete
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Table ID of the table to delete
* tableId: 'my-table-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.tables.delete(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.tables.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the table to delete
* @param {string} params.projectId Project ID of the table to delete
* @param {string} params.tableId Table ID of the table to delete
* @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$Tables$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Tables$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Tables$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* bigquery.tables.get
* @desc Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the requested table
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the requested table
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Table ID of the requested table
* tableId: 'my-table-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* bigquery.tables.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.tables.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the requested table
* @param {string} params.projectId Project ID of the requested table
* @param {string=} params.selectedFields List of fields to return (comma-separated). If unspecified, all fields are returned
* @param {string} params.tableId Table ID of the requested table
* @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$Tables$Get, options?: MethodOptions): GaxiosPromise<Schema$Table>;
get(params: Params$Resource$Tables$Get, options: MethodOptions | BodyResponseCallback<Schema$Table>, callback: BodyResponseCallback<Schema$Table>): void;
get(params: Params$Resource$Tables$Get, callback: BodyResponseCallback<Schema$Table>): void;
get(callback: BodyResponseCallback<Schema$Table>): void;
/**
* bigquery.tables.insert
* @desc Creates a new, empty table in the dataset.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the new table
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the new table
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* bigquery.tables.insert(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.tables.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the new table
* @param {string} params.projectId Project ID of the new table
* @param {().Table} 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
*/
insert(params?: Params$Resource$Tables$Insert, options?: MethodOptions): GaxiosPromise<Schema$Table>;
insert(params: Params$Resource$Tables$Insert, options: MethodOptions | BodyResponseCallback<Schema$Table>, callback: BodyResponseCallback<Schema$Table>): void;
insert(params: Params$Resource$Tables$Insert, callback: BodyResponseCallback<Schema$Table>): void;
insert(callback: BodyResponseCallback<Schema$Table>): void;
/**
* bigquery.tables.list
* @desc Lists all tables in the specified dataset. Requires the READER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the tables to list
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the tables to list
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var tablesPage = response['tables'];
* if (!tablesPage) {
* return;
* }
* for (var i = 0; i < tablesPage.length; i++) {
* // TODO: Change code below to process each resource in `tablesPage`:
* console.log(JSON.stringify(tablesPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* bigquery.tables.list(request, handlePage);
* }
* };
*
* bigquery.tables.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.tables.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the tables to list
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results
* @param {string} params.projectId Project ID of the tables to list
* @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$Tables$List, options?: MethodOptions): GaxiosPromise<Schema$TableList>;
list(params: Params$Resource$Tables$List, options: MethodOptions | BodyResponseCallback<Schema$TableList>, callback: BodyResponseCallback<Schema$TableList>): void;
list(params: Params$Resource$Tables$List, callback: BodyResponseCallback<Schema$TableList>): void;
list(callback: BodyResponseCallback<Schema$TableList>): void;
/**
* bigquery.tables.patch
* @desc Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the table to update
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the table to update
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Table ID of the table to update
* tableId: 'my-table-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. Only these properties
* // will be changed.
* },
*
* auth: authClient,
* };
*
* bigquery.tables.patch(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.tables.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the table to update
* @param {string} params.projectId Project ID of the table to update
* @param {string} params.tableId Table ID of the table to update
* @param {().Table} 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$Tables$Patch, options?: MethodOptions): GaxiosPromise<Schema$Table>;
patch(params: Params$Resource$Tables$Patch, options: MethodOptions | BodyResponseCallback<Schema$Table>, callback: BodyResponseCallback<Schema$Table>): void;
patch(params: Params$Resource$Tables$Patch, callback: BodyResponseCallback<Schema$Table>): void;
patch(callback: BodyResponseCallback<Schema$Table>): void;
/**
* bigquery.tables.update
* @desc Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var bigquery = google.bigquery('v2');
*
* authorize(function(authClient) {
* var request = {
* // Project ID of the table to update
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // Dataset ID of the table to update
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* // Table ID of the table to update
* tableId: 'my-table-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. All existing properties
* // will be replaced.
* },
*
* auth: authClient,
* };
*
* bigquery.tables.update(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias bigquery.tables.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.datasetId Dataset ID of the table to update
* @param {string} params.projectId Project ID of the table to update
* @param {string} params.tableId Table ID of the table to update
* @param {().Table} 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
*/
update(params?: Params$Resource$Tables$Update, options?: MethodOptions): GaxiosPromise<Schema$Table>;
update(params: Params$Resource$Tables$Update, options: MethodOptions | BodyResponseCallback<Schema$Table>, callback: BodyResponseCallback<Schema$Table>): void;
update(params: Params$Resource$Tables$Update, callback: BodyResponseCallback<Schema$Table>): void;
update(callback: BodyResponseCallback<Schema$Table>): void;
}
export interface Params$Resource$Tables$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the table to delete
*/
datasetId?: string;
/**
* Project ID of the table to delete
*/
projectId?: string;
/**
* Table ID of the table to delete
*/
tableId?: string;
}
export interface Params$Resource$Tables$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the requested table
*/
datasetId?: string;
/**
* Project ID of the requested table
*/
projectId?: string;
/**
* List of fields to return (comma-separated). If unspecified, all fields are returned
*/
selectedFields?: string;
/**
* Table ID of the requested table
*/
tableId?: string;
}
export interface Params$Resource$Tables$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the new table
*/
datasetId?: string;
/**
* Project ID of the new table
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Table;
}
export interface Params$Resource$Tables$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the tables to list
*/
datasetId?: string;
/**
* Maximum number of results to return
*/
maxResults?: number;
/**
* Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
* Project ID of the tables to list
*/
projectId?: string;
}
export interface Params$Resource$Tables$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the table to update
*/
datasetId?: string;
/**
* Project ID of the table to update
*/
projectId?: string;
/**
* Table ID of the table to update
*/
tableId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Table;
}
export interface Params$Resource$Tables$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dataset ID of the table to update
*/
datasetId?: string;
/**
* Project ID of the table to update
*/
projectId?: string;
/**
* Table ID of the table to update
*/
tableId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Table;
}
export {};
}