v1.d.ts
194 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
/**
* 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 cloudsearch_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Search API
*
* Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search.
*
* @example
* const {google} = require('googleapis');
* const cloudsearch = google.cloudsearch('v1');
*
* @namespace cloudsearch
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Cloudsearch
*/
export class Cloudsearch {
context: APIRequestContext;
debug: Resource$Debug;
indexing: Resource$Indexing;
media: Resource$Media;
operations: Resource$Operations;
query: Resource$Query;
settings: Resource$Settings;
stats: Resource$Stats;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
*/
export interface Schema$BooleanOperatorOptions {
/**
* Indicates the operator name required in the query in order to isolate the boolean property. For example, if operatorName is *closed* and the property's name is *isClosed*, then queries like *closed:<value>* will show results only where the value of the property named *isClosed* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
operatorName?: string | null;
}
/**
* Options for boolean properties.
*/
export interface Schema$BooleanPropertyOptions {
/**
* If set, describes how the boolean should be used as a search operator.
*/
operatorOptions?: Schema$BooleanOperatorOptions;
}
export interface Schema$CheckAccessResponse {
/**
* Returns true if principal has access. Returns false otherwise.
*/
hasAccess?: boolean | null;
}
export interface Schema$CompositeFilter {
/**
* The logic operator of the sub filter.
*/
logicOperator?: string | null;
/**
* Sub filters.
*/
subFilters?: Schema$Filter[];
}
/**
* Aggregation of items by status code as of the specified date.
*/
export interface Schema$CustomerIndexStats {
/**
* Date for which statistics were calculated.
*/
date?: Schema$Date;
/**
* Number of items aggregrated by status code.
*/
itemCountByStatus?: Schema$ItemCountByStatus[];
}
export interface Schema$CustomerQueryStats {
/**
* Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.
*/
date?: Schema$Date;
queryCountByStatus?: Schema$QueryCountByStatus[];
}
export interface Schema$CustomerSessionStats {
/**
* Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
*/
date?: Schema$Date;
/**
* The count of search sessions on the day
*/
searchSessionsCount?: string | null;
}
export interface Schema$CustomerUserStats {
/**
* Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
*/
date?: Schema$Date;
/**
* The count of unique active users in the past one day
*/
oneDayActiveUsersCount?: string | null;
/**
* The count of unique active users in the past seven days
*/
sevenDaysActiveUsersCount?: string | null;
/**
* The count of unique active users in the past thirty days
*/
thirtyDaysActiveUsersCount?: string | null;
}
/**
* Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
*/
export interface Schema$DataSource {
/**
* If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.
*/
disableModifications?: boolean | null;
/**
* Disable serving any search or assist results.
*/
disableServing?: boolean | null;
/**
* Required. Display name of the datasource The maximum length is 300 characters.
*/
displayName?: string | null;
/**
* List of service accounts that have indexing access.
*/
indexingServiceAccounts?: string[] | null;
/**
* This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
*/
itemsVisibility?: Schema$GSuitePrincipal[];
/**
* Name of the datasource resource. Format: datasources/{source_id}. <br />The name is ignored when creating a datasource.
*/
name?: string | null;
/**
* IDs of the Long Running Operations (LROs) currently running for this schema.
*/
operationIds?: string[] | null;
/**
* A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
*/
shortName?: string | null;
}
/**
* Aggregation of items by status code as of the specified date.
*/
export interface Schema$DataSourceIndexStats {
/**
* Date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned.
*/
date?: Schema$Date;
/**
* Number of items aggregrated by status code.
*/
itemCountByStatus?: Schema$ItemCountByStatus[];
}
/**
* Restriction on Datasource.
*/
export interface Schema$DataSourceRestriction {
/**
* Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
*/
filterOptions?: Schema$FilterOptions[];
/**
* The source of restriction.
*/
source?: Schema$Source;
}
/**
* Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
*/
export interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
day?: number | null;
/**
* Month of date. Must be from 1 to 12.
*/
month?: number | null;
/**
* Year of date. Must be from 1 to 9999.
*/
year?: number | null;
}
/**
* Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
*/
export interface Schema$DateOperatorOptions {
/**
* Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:&lt;value&gt;* will show results only where the value of the property named *closeDate* is later than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
greaterThanOperatorName?: string | null;
/**
* Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:&lt;value&gt;* will show results only where the value of the property named *closeDate* is earlier than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
lessThanOperatorName?: string | null;
/**
* Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:&lt;value&gt;* will show results only where the value of the *closeDate* property matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
operatorName?: string | null;
}
/**
* Options for date properties.
*/
export interface Schema$DatePropertyOptions {
/**
* If set, describes how the date should be used as a search operator.
*/
operatorOptions?: Schema$DateOperatorOptions;
}
/**
* List of date values.
*/
export interface Schema$DateValues {
values?: Schema$Date[];
}
/**
* Shared request debug options for all cloudsearch RPC methods.
*/
export interface Schema$DebugOptions {
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
enableDebugging?: boolean | null;
}
export interface Schema$DeleteQueueItemsRequest {
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string | null;
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
/**
* Name of a queue to delete items from.
*/
queue?: string | null;
}
/**
* A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties will be displayed in the search results along with the dislpay label for that property if one is specified. If a display label is not specified, only the values will be shown.
*/
export interface Schema$DisplayedProperty {
/**
* The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error will be given when attempting to update the schema.
*/
propertyName?: string | null;
}
/**
* Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
*/
export interface Schema$DoubleOperatorOptions {
/**
* Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
operatorName?: string | null;
}
/**
* Options for double properties.
*/
export interface Schema$DoublePropertyOptions {
/**
* If set, describes how the double should be used as a search operator.
*/
operatorOptions?: Schema$DoubleOperatorOptions;
}
/**
* List of double values.
*/
export interface Schema$DoubleValues {
values?: number[] | null;
}
/**
* Drive follow-up search restricts (e.g. "followup:suggestions").
*/
export interface Schema$DriveFollowUpRestrict {
type?: string | null;
}
/**
* Drive location search restricts (e.g. "is:starred").
*/
export interface Schema$DriveLocationRestrict {
type?: string | null;
}
/**
* Drive mime-type search restricts (e.g. "type:pdf").
*/
export interface Schema$DriveMimeTypeRestrict {
type?: string | null;
}
/**
* The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12").
*/
export interface Schema$DriveTimeSpanRestrict {
type?: string | null;
}
/**
* A person's email address.
*/
export interface Schema$EmailAddress {
/**
* The email address.
*/
emailAddress?: string | null;
}
/**
* Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* will return items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*.
*/
export interface Schema$EnumOperatorOptions {
/**
* Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:&lt;value&gt;* will show results only where the value of the property named *priorityVal* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
operatorName?: string | null;
}
/**
* Options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*.
*/
export interface Schema$EnumPropertyOptions {
/**
* If set, describes how the enum should be used as a search operator.
*/
operatorOptions?: Schema$EnumOperatorOptions;
/**
* Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.
*/
orderedRanking?: string | null;
/**
* The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100.
*/
possibleValues?: Schema$EnumValuePair[];
}
/**
* The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking.
*/
export interface Schema$EnumValuePair {
/**
* The integer value of the EnumValuePair which must be non-negative. Optional.
*/
integerValue?: number | null;
/**
* The string value of the EnumValuePair. The maximum length is 32 characters.
*/
stringValue?: string | null;
}
/**
* List of enum values.
*/
export interface Schema$EnumValues {
/**
* The maximum allowable length for string values is 32 characters.
*/
values?: string[] | null;
}
/**
* Error information about the response.
*/
export interface Schema$ErrorInfo {
errorMessages?: Schema$ErrorMessage[];
}
/**
* Error message per source response.
*/
export interface Schema$ErrorMessage {
errorMessage?: string | null;
source?: Schema$Source;
}
/**
* A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.
*/
export interface Schema$FacetBucket {
/**
* Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Can be empty.
*/
count?: number | null;
/**
* Percent of results that match the bucket value. This value is between (0-100]. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.
*/
percentage?: number | null;
value?: Schema$Value;
}
/**
* Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
*/
export interface Schema$FacetOptions {
/**
* Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
*/
numFacetBuckets?: number | null;
/**
* If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
*/
objectType?: string | null;
/**
* Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
*/
operatorName?: string | null;
/**
* Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
*/
sourceName?: string | null;
}
/**
* Source specific facet response
*/
export interface Schema$FacetResult {
/**
* FacetBuckets for values in response containing at least a single result.
*/
buckets?: Schema$FacetBucket[];
/**
* Object type for which facet results are returned. Can be empty.
*/
objectType?: string | null;
/**
* Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
*/
operatorName?: string | null;
/**
* Source name for which facet results are returned. Will not be empty.
*/
sourceName?: string | null;
}
export interface Schema$FieldViolation {
/**
* Description of the error.
*/
description?: string | null;
/**
* Path of field with violation.
*/
field?: string | null;
}
/**
* A generic way of expressing filters in a query, which supports two approaches: <br/><br/> **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. <br/> **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.
*/
export interface Schema$Filter {
compositeFilter?: Schema$CompositeFilter;
valueFilter?: Schema$ValueFilter;
}
/**
* Filter options to be applied on query.
*/
export interface Schema$FilterOptions {
/**
* Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
*/
filter?: Schema$Filter;
/**
* If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
*/
objectType?: string | null;
}
/**
* Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.
*/
export interface Schema$FreshnessOptions {
/**
* The duration after which an object should be considered stale. The default value is 180 days (in seconds).
*/
freshnessDuration?: string | null;
/**
* This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate fresheness, the value defaults to 2 years from the current time.
*/
freshnessProperty?: string | null;
}
export interface Schema$GetCustomerIndexStatsResponse {
/**
* Summary of indexed item counts, one for each day in the requested range.
*/
stats?: Schema$CustomerIndexStats[];
}
export interface Schema$GetCustomerQueryStatsResponse {
stats?: Schema$CustomerQueryStats[];
}
export interface Schema$GetCustomerSessionStatsResponse {
stats?: Schema$CustomerSessionStats[];
}
export interface Schema$GetCustomerUserStatsResponse {
stats?: Schema$CustomerUserStats[];
}
export interface Schema$GetDataSourceIndexStatsResponse {
/**
* Summary of indexed item counts, one for each day in the requested range.
*/
stats?: Schema$DataSourceIndexStats[];
}
export interface Schema$GetSearchApplicationQueryStatsResponse {
stats?: Schema$SearchApplicationQueryStats[];
}
export interface Schema$GetSearchApplicationSessionStatsResponse {
stats?: Schema$SearchApplicationSessionStats[];
}
export interface Schema$GetSearchApplicationUserStatsResponse {
stats?: Schema$SearchApplicationUserStats[];
}
/**
* Gmail Action restricts (i.e. read/replied/snoozed).
*/
export interface Schema$GmailActionRestrict {
type?: string | null;
}
/**
* Gmail Attachment restricts (i.e. has:attachment, has:drive, filename:pdf).
*/
export interface Schema$GmailAttachmentRestrict {
type?: string | null;
}
/**
* Gmail Folder restricts (i.e. in Drafts/Sent/Chats/User Generated Labels).
*/
export interface Schema$GmailFolderRestrict {
type?: string | null;
}
/**
* Gmail Intelligent restricts (i.e. smartlabels, important).
*/
export interface Schema$GmailIntelligentRestrict {
type?: string | null;
}
/**
* Gmail Time restricts (i.e. received today, this week).
*/
export interface Schema$GmailTimeRestrict {
type?: string | null;
}
export interface Schema$GSuitePrincipal {
/**
* This principal represents all users of the G Suite domain of the customer.
*/
gsuiteDomain?: boolean | null;
/**
* This principal references a G Suite group account
*/
gsuiteGroupEmail?: string | null;
/**
* This principal references a G Suite user account
*/
gsuiteUserEmail?: string | null;
}
/**
* Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
*/
export interface Schema$HtmlOperatorOptions {
/**
* Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:&lt;value&gt;* will show results only where the value of the property named *subjectLine* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
operatorName?: string | null;
}
/**
* Options for html properties.
*/
export interface Schema$HtmlPropertyOptions {
/**
* If set, describes how the property should be used as a search operator.
*/
operatorOptions?: Schema$HtmlOperatorOptions;
/**
* Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE.
*/
retrievalImportance?: Schema$RetrievalImportance;
}
/**
* List of html values.
*/
export interface Schema$HtmlValues {
/**
* The maximum allowable length for html values is 2048 characters.
*/
values?: string[] | null;
}
export interface Schema$IndexItemOptions {
/**
* Specifies if the index request should allow gsuite principals that do not exist or are deleted in the index request.
*/
allowUnknownGsuitePrincipals?: boolean | null;
}
export interface Schema$IndexItemRequest {
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string | null;
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
indexItemOptions?: Schema$IndexItemOptions;
/**
* Name of the item. Format: datasources/{source_id}/items/{item_id}
*/
item?: Schema$Item;
/**
* Required. The RequestMode for this request.
*/
mode?: string | null;
}
/**
* Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
*/
export interface Schema$IntegerOperatorOptions {
/**
* Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:&lt;value&gt;* will show results only where the value of the property named *priorityVal* is greater than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
greaterThanOperatorName?: string | null;
/**
* Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:&lt;value&gt;* will show results only where the value of the property named *priorityVal* is less than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
lessThanOperatorName?: string | null;
/**
* Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:&lt;value&gt;* will show results only where the value of the property named *priorityVal* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
operatorName?: string | null;
}
/**
* Options for integer properties.
*/
export interface Schema$IntegerPropertyOptions {
/**
* The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value.
*/
maximumValue?: string | null;
/**
* The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value.
*/
minimumValue?: string | null;
/**
* If set, describes how the integer should be used as a search operator.
*/
operatorOptions?: Schema$IntegerOperatorOptions;
/**
* Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false.
*/
orderedRanking?: string | null;
}
/**
* List of integer values.
*/
export interface Schema$IntegerValues {
values?: string[] | null;
}
/**
* Represents an interaction between a user and an item.
*/
export interface Schema$Interaction {
/**
* The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
*/
interactionTime?: string | null;
/**
* The user that acted on the item.
*/
principal?: Schema$Principal;
type?: string | null;
}
/**
* Represents a single object that is an item in the search index, such as a file, folder, or a database record.
*/
export interface Schema$Item {
/**
* Access control list for this item.
*/
acl?: Schema$ItemAcl;
/**
* Item content to be indexed and made text searchable.
*/
content?: Schema$ItemContent;
/**
* Type for this item.
*/
itemType?: string | null;
/**
* Metadata information.
*/
metadata?: Schema$ItemMetadata;
/**
* Name of the Item. Format: datasources/{source_id}/items/{item_id} <br />This is a required field. The maximum length is 1536 characters.
*/
name?: string | null;
/**
* Additional state connector can store for this item. The maximum length is 10000 bytes.
*/
payload?: string | null;
/**
* Queue this item belongs to. The maximum length is 100 characters.
*/
queue?: string | null;
/**
* Status of the item. Output only field.
*/
status?: Schema$ItemStatus;
/**
* The structured data for the item that should conform to a registered object definition in the schema for the data source.
*/
structuredData?: Schema$ItemStructuredData;
/**
* Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. <br /><br /> Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
*/
version?: string | null;
}
/**
* Access control list information for the item. For more information see https://developers.google.com/cloud-search/docs/guides/index-your-data#acls
*/
export interface Schema$ItemAcl {
/**
* Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
*/
aclInheritanceType?: string | null;
/**
* List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
*/
deniedReaders?: Schema$Principal[];
/**
* Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
*/
inheritAclFrom?: string | null;
/**
* Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
*/
owners?: Schema$Principal[];
/**
* List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
*/
readers?: Schema$Principal[];
}
/**
* Content of an item to be indexed and surfaced by Cloud Search.
*/
export interface Schema$ItemContent {
/**
* Upload reference ID of a previously uploaded content via write method.
*/
contentDataRef?: Schema$UploadItemRef;
contentFormat?: string | null;
/**
* Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
*/
hash?: string | null;
/**
* Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB).
*/
inlineContent?: string | null;
}
export interface Schema$ItemCountByStatus {
/**
* Number of items matching the status code.
*/
count?: string | null;
/**
* Status of the items.
*/
statusCode?: string | null;
}
/**
* Available metadata fields for the item.
*/
export interface Schema$ItemMetadata {
/**
* The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
*/
containerName?: string | null;
/**
* The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
*/
contentLanguage?: string | null;
/**
* The time when the item was created in the source repository.
*/
createTime?: string | null;
/**
* Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
*/
hash?: string | null;
/**
* A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
*/
interactions?: Schema$Interaction[];
/**
* Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
*/
keywords?: string[] | null;
/**
* The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
*/
mimeType?: string | null;
/**
* The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
*/
objectType?: string | null;
/**
* Additional search quality metadata of the item
*/
searchQualityMetadata?: Schema$SearchQualityMetadata;
/**
* Link to the source repository serving the data. &#83;earch results apply this link to the title. The maximum length is 2048 characters.
*/
sourceRepositoryUrl?: string | null;
/**
* The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
*/
title?: string | null;
/**
* The time when the item was last modified in the source repository.
*/
updateTime?: string | null;
}
/**
* This contains item's status and any errors.
*/
export interface Schema$ItemStatus {
/**
* Status code.
*/
code?: string | null;
/**
* Error details in case the item is in ERROR state.
*/
processingErrors?: Schema$ProcessingError[];
/**
* Repository error reported by connector.
*/
repositoryErrors?: Schema$RepositoryError[];
}
/**
* Available structured data fields for the item.
*/
export interface Schema$ItemStructuredData {
/**
* Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
*/
hash?: string | null;
/**
* The structured data object that should conform to a registered object definition in the schema for the data source.
*/
object?: Schema$StructuredDataObject;
}
export interface Schema$ListDataSourceResponse {
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
sources?: Schema$DataSource[];
}
export interface Schema$ListItemNamesForUnmappedIdentityResponse {
itemNames?: string[] | null;
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
}
export interface Schema$ListItemsResponse {
items?: Schema$Item[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
}
/**
* List sources response.
*/
export interface Schema$ListQuerySourcesResponse {
nextPageToken?: string | null;
sources?: Schema$QuerySource[];
}
export interface Schema$ListSearchApplicationsResponse {
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
searchApplications?: Schema$SearchApplication[];
}
export interface Schema$ListUnmappedIdentitiesResponse {
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
unmappedIdentities?: Schema$UnmappedIdentity[];
}
/**
* Matched range of a snippet [start, end).
*/
export interface Schema$MatchRange {
/**
* End of the match in the snippet.
*/
end?: number | null;
/**
* Starting position of the match in the snippet.
*/
start?: number | null;
}
/**
* Media resource.
*/
export interface Schema$Media {
/**
* Name of the media resource.
*/
resourceName?: string | null;
}
/**
* Metadata of a matched search result.
*/
export interface Schema$Metadata {
/**
* The creation time for this document or object in the search result.
*/
createTime?: string | null;
/**
* Options that specify how to display a structured data search result.
*/
displayOptions?: Schema$ResultDisplayMetadata;
/**
* Indexed fields in structured data, returned as a generic named property.
*/
fields?: Schema$NamedProperty[];
/**
* Mime type of the search result.
*/
mimeType?: string | null;
/**
* Object type of the search result.
*/
objectType?: string | null;
/**
* Owner (usually creator) of the document or object of the search result.
*/
owner?: Schema$Person;
/**
* The named source for the result, such as Gmail.
*/
source?: Schema$Source;
/**
* The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.
*/
updateTime?: string | null;
}
/**
* A metaline is a list of properties that are displayed along with the search result to provide context.
*/
export interface Schema$Metaline {
/**
* The list of displayed properties for the metaline. The maxiumum number of properties is 5.
*/
properties?: Schema$DisplayedProperty[];
}
/**
* A person's name.
*/
export interface Schema$Name {
/**
* The read-only display name formatted according to the locale specified by the viewer's account or the <code>Accept-Language</code> HTTP header.
*/
displayName?: string | null;
}
/**
* A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
*/
export interface Schema$NamedProperty {
booleanValue?: boolean | null;
dateValues?: Schema$DateValues;
doubleValues?: Schema$DoubleValues;
enumValues?: Schema$EnumValues;
htmlValues?: Schema$HtmlValues;
integerValues?: Schema$IntegerValues;
/**
* The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.
*/
name?: string | null;
objectValues?: Schema$ObjectValues;
textValues?: Schema$TextValues;
timestampValues?: Schema$TimestampValues;
}
/**
* The definition for an object within a data source.
*/
export interface Schema$ObjectDefinition {
/**
* Name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.
*/
name?: string | null;
/**
* The optional object-specific options.
*/
options?: Schema$ObjectOptions;
/**
* The property definitions for the object. The maximum number of elements is 1000.
*/
propertyDefinitions?: Schema$PropertyDefinition[];
}
/**
* The display options for an object.
*/
export interface Schema$ObjectDisplayOptions {
/**
* Defines the properties that will be displayed in the metalines of the search results. The property values will be displayed in the order given here. If a property holds multiple values, all of the values will be diplayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of metalines is 3.
*/
metalines?: Schema$Metaline[];
/**
* The user friendly label to display in the search result to inidicate the type of the item. This is OPTIONAL; if not given, an object label will not be displayed on the context line of the search results. The maximum length is 32 characters.
*/
objectDisplayLabel?: string | null;
}
/**
* The options for an object.
*/
export interface Schema$ObjectOptions {
/**
* Options that determine how the object is displayed in the Cloud Search results page.
*/
displayOptions?: Schema$ObjectDisplayOptions;
/**
* The freshness options for an object.
*/
freshnessOptions?: Schema$FreshnessOptions;
}
/**
* Options for object properties.
*/
export interface Schema$ObjectPropertyOptions {
/**
* The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000.
*/
subobjectProperties?: Schema$PropertyDefinition[];
}
/**
* List of object values.
*/
export interface Schema$ObjectValues {
values?: Schema$StructuredDataObject[];
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* This field contains information about the person being suggested.
*/
export interface Schema$PeopleSuggestion {
/**
* Suggested person. All fields of the person object might not be populated.
*/
person?: Schema$Person;
}
/**
* Object to represent a person.
*/
export interface Schema$Person {
/**
* The person's email addresses
*/
emailAddresses?: Schema$EmailAddress[];
/**
* The resource name of the person to provide information about. See <a href="https://developers.google.com/people/api/rest/v1/people/get"> People.get</a> from Google People API.
*/
name?: string | null;
/**
* Obfuscated ID of a person.
*/
obfuscatedId?: string | null;
/**
* The person's name
*/
personNames?: Schema$Name[];
/**
* A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.
*/
photos?: Schema$Photo[];
}
/**
* A person's photo.
*/
export interface Schema$Photo {
/**
* The URL of the photo.
*/
url?: string | null;
}
export interface Schema$PollItemsRequest {
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string | null;
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
/**
* Maximum number of items to return. <br />The maximum and the default value is 1000
*/
limit?: number | null;
/**
* Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.
*/
queue?: string | null;
/**
* Limit the items polled to the ones with these statuses.
*/
statusCodes?: string[] | null;
}
export interface Schema$PollItemsResponse {
/**
* Set of items from the queue available for connector to process. <br />These items have the following subset of fields populated: <br /> <br />version <br />metadata.hash <br />structured_data.hash <br />content.hash <br />payload <br />status <br />queue
*/
items?: Schema$Item[];
}
/**
* Reference to a user, group, or domain.
*/
export interface Schema$Principal {
/**
* This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
*/
groupResourceName?: string | null;
/**
* This principal is a GSuite user, group or domain.
*/
gsuitePrincipal?: Schema$GSuitePrincipal;
/**
* This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
*/
userResourceName?: string | null;
}
export interface Schema$ProcessingError {
/**
* Error code indicating the nature of the error.
*/
code?: string | null;
/**
* Description of the error.
*/
errorMessage?: string | null;
/**
* In case the item fields are invalid, this field contains the details about the validation errors.
*/
fieldViolations?: Schema$FieldViolation[];
}
/**
* The definition of a property within an object.
*/
export interface Schema$PropertyDefinition {
booleanPropertyOptions?: Schema$BooleanPropertyOptions;
datePropertyOptions?: Schema$DatePropertyOptions;
/**
* Options that determine how the property is displayed in the Cloud Search results page if it is specified to be displayed in the object's display options .
*/
displayOptions?: Schema$PropertyDisplayOptions;
doublePropertyOptions?: Schema$DoublePropertyOptions;
enumPropertyOptions?: Schema$EnumPropertyOptions;
htmlPropertyOptions?: Schema$HtmlPropertyOptions;
integerPropertyOptions?: Schema$IntegerPropertyOptions;
/**
* Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for Boolean, Enum, and Text properties.
*/
isFacetable?: boolean | null;
/**
* Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value will cause the indexing request for that item to be rejected.
*/
isRepeatable?: boolean | null;
/**
* Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object.
*/
isReturnable?: boolean | null;
/**
* Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object or user identifier. IsReturnable must be true to set this option. Only supported for Boolean, Date, Double, Integer, and Timestamp properties.
*/
isSortable?: boolean | null;
/**
* Indicates that the property can be used for generating query suggestions.
*/
isSuggestable?: boolean | null;
/**
* Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. Note: This is an alpha feature and is enabled for whitelisted users only.
*/
isWildcardSearchable?: boolean | null;
/**
* The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.
*/
name?: string | null;
objectPropertyOptions?: Schema$ObjectPropertyOptions;
textPropertyOptions?: Schema$TextPropertyOptions;
timestampPropertyOptions?: Schema$TimestampPropertyOptions;
}
/**
* The display options for a property.
*/
export interface Schema$PropertyDisplayOptions {
/**
* The user friendly label for the property that will be used if the property is specified to be displayed in ObjectDisplayOptions. If given, the display label will be shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user will see 'priority : 1' in the search results which provides clear conext to search users. This is OPTIONAL; if not given, only the property values will be displayed. The maximum length is 32 characters.
*/
displayLabel?: string | null;
}
/**
* Represents an item to be pushed to the indexing queue.
*/
export interface Schema$PushItem {
/**
* Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
*/
contentHash?: string | null;
/**
* Metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
*/
metadataHash?: string | null;
/**
* Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes.
*/
payload?: string | null;
/**
* Queue to which this item belongs to. The <code>default</code> queue is chosen if this field is not specified. The maximum length is 512 characters.
*/
queue?: string | null;
/**
* Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR.
*/
repositoryError?: Schema$RepositoryError;
/**
* Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
*/
structuredDataHash?: string | null;
/**
* The type of the push operation that defines the push behavior.
*/
type?: string | null;
}
export interface Schema$PushItemRequest {
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string | null;
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
/**
* Item to push onto the queue.
*/
item?: Schema$PushItem;
}
export interface Schema$QueryCountByStatus {
count?: string | null;
/**
* This represents the http status code.
*/
statusCode?: number | null;
}
export interface Schema$QueryInterpretation {
interpretationType?: string | null;
/**
* The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NO_RESULTS_FOUND_FOR_USER_QUERY.
*/
interpretedQuery?: string | null;
/**
* The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.
*/
reason?: string | null;
}
/**
* Options to interpret user query.
*/
export interface Schema$QueryInterpretationOptions {
/**
* Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.
*/
disableNlInterpretation?: boolean | null;
/**
* Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.
*/
enableVerbatimMode?: boolean | null;
}
/**
* Information relevant only to a query entry.
*/
export interface Schema$QueryItem {
/**
* True if the text was generated by means other than a previous user search.
*/
isSynthetic?: boolean | null;
}
/**
* The definition of a operator that can be used in a Search/Suggest request.
*/
export interface Schema$QueryOperator {
/**
* Display name of the operator
*/
displayName?: string | null;
/**
* Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator.
*/
enumValues?: string[] | null;
/**
* Indicates the operator name that can be used to isolate the property using the greater-than operator.
*/
greaterThanOperatorName?: string | null;
/**
* Can this operator be used to get facets.
*/
isFacetable?: boolean | null;
/**
* Indicates if multiple values can be set for this property.
*/
isRepeatable?: boolean | null;
/**
* Will the property associated with this facet be returned as part of search results.
*/
isReturnable?: boolean | null;
/**
* Can this operator be used to sort results.
*/
isSortable?: boolean | null;
/**
* Can get suggestions for this field.
*/
isSuggestable?: boolean | null;
/**
* Indicates the operator name that can be used to isolate the property using the less-than operator.
*/
lessThanOperatorName?: string | null;
/**
* The name of the operator.
*/
operatorName?: string | null;
/**
* Type of the operator.
*/
type?: string | null;
}
/**
* List of sources that the user can search using the query API.
*/
export interface Schema$QuerySource {
/**
* Display name of the data source.
*/
displayName?: string | null;
/**
* List of all operators applicable for this source.
*/
operators?: Schema$QueryOperator[];
/**
* A short name or alias for the source. This value can be used with the 'source' operator.
*/
shortName?: string | null;
/**
* Name of the source
*/
source?: Schema$Source;
}
/**
* This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.
*/
export interface Schema$QuerySuggestion {
}
/**
* Errors when the connector is communicating to the source repository.
*/
export interface Schema$RepositoryError {
/**
* Message that describes the error. The maximum allowable length of the message is 8192 characters.
*/
errorMessage?: string | null;
/**
* Error codes. Matches the definition of HTTP status codes.
*/
httpStatusCode?: number | null;
/**
* Type of error.
*/
type?: string | null;
}
/**
* Shared request options for all RPC methods.
*/
export interface Schema$RequestOptions {
/**
* Debug options of the request
*/
debugOptions?: Schema$DebugOptions;
/**
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.
*/
languageCode?: string | null;
/**
* Id of the application created using SearchApplicationsService.
*/
searchApplicationId?: string | null;
/**
* Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
*/
timeZone?: string | null;
}
export interface Schema$ResetSearchApplicationRequest {
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
}
/**
* Debugging information about the response.
*/
export interface Schema$ResponseDebugInfo {
/**
* General debug info formatted for display.
*/
formattedDebugInfo?: string | null;
}
/**
* Information relevant only to a restrict entry. NextId: 12
*/
export interface Schema$RestrictItem {
/**
* LINT.ThenChange(//depot/google3/java/com/google/apps/search/quality/itemsuggest/utils/SubtypeRerankingUtils.java)
*/
driveFollowUpRestrict?: Schema$DriveFollowUpRestrict;
driveLocationRestrict?: Schema$DriveLocationRestrict;
/**
* LINT.IfChange Drive Types.
*/
driveMimeTypeRestrict?: Schema$DriveMimeTypeRestrict;
driveTimeSpanRestrict?: Schema$DriveTimeSpanRestrict;
gmailActionRestrict?: Schema$GmailActionRestrict;
gmailAttachmentRestrict?: Schema$GmailAttachmentRestrict;
/**
* Gmail Types.
*/
gmailFolderRestrict?: Schema$GmailFolderRestrict;
gmailIntelligentRestrict?: Schema$GmailIntelligentRestrict;
gmailTimeRestrict?: Schema$GmailTimeRestrict;
/**
* The search restrict (e.g. "after:2017-09-11 before:2017-09-12").
*/
searchOperator?: string | null;
}
/**
* Result count information
*/
export interface Schema$ResultCounts {
/**
* Result count information for each source with results.
*/
sourceResultCounts?: Schema$SourceResultCount[];
}
/**
* Debugging information about the result.
*/
export interface Schema$ResultDebugInfo {
/**
* General debug info formatted for display.
*/
formattedDebugInfo?: string | null;
}
/**
* Display Fields for Search Results
*/
export interface Schema$ResultDisplayField {
/**
* The display label for the property.
*/
label?: string | null;
/**
* The operator name of the property.
*/
operatorName?: string | null;
/**
* The name value pair for the property.
*/
property?: Schema$NamedProperty;
}
/**
* The collection of fields that make up a displayed line
*/
export interface Schema$ResultDisplayLine {
fields?: Schema$ResultDisplayField[];
}
export interface Schema$ResultDisplayMetadata {
/**
* The metalines content to be displayed with the result.
*/
metalines?: Schema$ResultDisplayLine[];
/**
* The display label for the object.
*/
objectTypeLabel?: string | null;
}
export interface Schema$RetrievalImportance {
/**
* Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.
*/
importance?: string | null;
}
/**
* The schema definition for a data source.
*/
export interface Schema$Schema {
/**
* The list of top-level objects for the data source. The maximum number of elements is 10.
*/
objectDefinitions?: Schema$ObjectDefinition[];
/**
* IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content.
*/
operationIds?: string[] | null;
}
/**
* Scoring configurations for a source while processing a Search or Suggest request.
*/
export interface Schema$ScoringConfig {
/**
* Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
*/
disableFreshness?: boolean | null;
/**
* Whether to personalize the results. By default, personal signals will be used to boost results.
*/
disablePersonalization?: boolean | null;
}
/**
* SearchApplication
*/
export interface Schema$SearchApplication {
/**
* Retrictions applied to the configurations. The maximum number of elements is 10.
*/
dataSourceRestrictions?: Schema$DataSourceRestriction[];
/**
* The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
*/
defaultFacetOptions?: Schema$FacetOptions[];
/**
* The default options for sorting the search results
*/
defaultSortOptions?: Schema$SortOptions;
/**
* Display name of the Search Application. The maximum length is 300 characters.
*/
displayName?: string | null;
/**
* Name of the Search Application. <br />Format: searchapplications/{application_id}.
*/
name?: string | null;
/**
* IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
*/
operationIds?: string[] | null;
/**
* Configuration for ranking results.
*/
scoringConfig?: Schema$ScoringConfig;
/**
* Configuration for a sources specified in data_source_restrictions.
*/
sourceConfig?: Schema$SourceConfig[];
}
export interface Schema$SearchApplicationQueryStats {
/**
* Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.
*/
date?: Schema$Date;
queryCountByStatus?: Schema$QueryCountByStatus[];
}
export interface Schema$SearchApplicationSessionStats {
/**
* Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
*/
date?: Schema$Date;
/**
* The count of search sessions on the day
*/
searchSessionsCount?: string | null;
}
export interface Schema$SearchApplicationUserStats {
/**
* Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
*/
date?: Schema$Date;
/**
* The count of unique active users in the past one day
*/
oneDayActiveUsersCount?: string | null;
/**
* The count of unique active users in the past seven days
*/
sevenDaysActiveUsersCount?: string | null;
/**
* The count of unique active users in the past thirty days
*/
thirtyDaysActiveUsersCount?: string | null;
}
export interface Schema$SearchItemsByViewUrlRequest {
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
/**
* The next_page_token value returned from a previous request, if any.
*/
pageToken?: string | null;
/**
* Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.
*/
viewUrl?: string | null;
}
export interface Schema$SearchItemsByViewUrlResponse {
items?: Schema$Item[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
}
/**
* Additional search quality metadata of the item.
*/
export interface Schema$SearchQualityMetadata {
/**
* An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
*/
quality?: number | null;
}
/**
* The search API request.
*/
export interface Schema$SearchRequest {
/**
* The sources to use for querying. If not specified, all data sources from the current search application are used.
*/
dataSourceRestrictions?: Schema$DataSourceRestriction[];
facetOptions?: Schema$FacetOptions[];
/**
* Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10.
*/
pageSize?: number | null;
/**
* The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/)
*/
query?: string | null;
/**
* Options to interpret the user query.
*/
queryInterpretationOptions?: Schema$QueryInterpretationOptions;
/**
* Request options, such as the search application and user timezone.
*/
requestOptions?: Schema$RequestOptions;
/**
* The options for sorting the search results
*/
sortOptions?: Schema$SortOptions;
/**
* Starting index of the results.
*/
start?: number | null;
}
/**
* The search API response.
*/
export interface Schema$SearchResponse {
/**
* Debugging information about the response.
*/
debugInfo?: Schema$ResponseDebugInfo;
/**
* Error information about the response.
*/
errorInfo?: Schema$ErrorInfo;
/**
* Repeated facet results.
*/
facetResults?: Schema$FacetResult[];
/**
* Whether there are more search results matching the query.
*/
hasMoreResults?: boolean | null;
/**
* Query interpretation result for user query. Empty if query interpretation is disabled.
*/
queryInterpretation?: Schema$QueryInterpretation;
/**
* The estimated result count for this query.
*/
resultCountEstimate?: string | null;
/**
* The exact result count for this query.
*/
resultCountExact?: string | null;
/**
* Expanded result count information.
*/
resultCounts?: Schema$ResultCounts;
/**
* Results from a search query.
*/
results?: Schema$SearchResult[];
/**
* Suggested spelling for the query.
*/
spellResults?: Schema$SpellResult[];
/**
* Structured results for the user query. These results are not counted against the page_size.
*/
structuredResults?: Schema$StructuredResult[];
}
/**
* Results containing indexed information for a document.
*/
export interface Schema$SearchResult {
/**
* If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.
*/
clusteredResults?: Schema$SearchResult[];
/**
* Debugging information about this search result.
*/
debugInfo?: Schema$ResultDebugInfo;
/**
* Metadata of the search result.
*/
metadata?: Schema$Metadata;
/**
* The concatenation of all snippets (summaries) available for this result.
*/
snippet?: Schema$Snippet;
/**
* Title of the search result.
*/
title?: string | null;
/**
* The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed.
*/
url?: string | null;
}
/**
* Snippet of the search result, which summarizes the content of the resulting page.
*/
export interface Schema$Snippet {
/**
* The matched ranges in the snippet.
*/
matchRanges?: Schema$MatchRange[];
/**
* The snippet of the document. The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.
*/
snippet?: string | null;
}
export interface Schema$SortOptions {
/**
* Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
*/
operatorName?: string | null;
/**
* Ascending is the default sort order
*/
sortOrder?: string | null;
}
/**
* Defines sources for the suggest/search APIs.
*/
export interface Schema$Source {
/**
* Source name for content indexed by the Indexing API.
*/
name?: string | null;
/**
* Predefined content source for Google Apps.
*/
predefinedSource?: string | null;
}
/**
* Configurations for a source while processing a Search or Suggest request.
*/
export interface Schema$SourceConfig {
/**
* The crowding configuration for the source.
*/
crowdingConfig?: Schema$SourceCrowdingConfig;
/**
* The scoring configuration for the source.
*/
scoringConfig?: Schema$SourceScoringConfig;
/**
* The source for which this configuration is to be used.
*/
source?: Schema$Source;
}
/**
* Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.
*/
export interface Schema$SourceCrowdingConfig {
/**
* Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
*/
numResults?: number | null;
/**
* Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
*/
numSuggestions?: number | null;
}
/**
* Per source result count information.
*/
export interface Schema$SourceResultCount {
/**
* Whether there are more search results for this source.
*/
hasMoreResults?: boolean | null;
/**
* The estimated result count for this source.
*/
resultCountEstimate?: string | null;
/**
* The exact result count for this source.
*/
resultCountExact?: string | null;
/**
* The source the result count information is associated with.
*/
source?: Schema$Source;
}
/**
* Set the scoring configuration. This allows modifying the ranking of results for a source.
*/
export interface Schema$SourceScoringConfig {
/**
* Importance of the source.
*/
sourceImportance?: string | null;
}
export interface Schema$SpellResult {
/**
* The suggested spelling of the query.
*/
suggestedQuery?: string | null;
}
/**
* Start upload file request.
*/
export interface Schema$StartUploadItemRequest {
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string | null;
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* A structured data object consisting of named properties.
*/
export interface Schema$StructuredDataObject {
/**
* The properties for the object. The maximum number of elements is 1000.
*/
properties?: Schema$NamedProperty[];
}
/**
* Structured results that are returned as part of search request.
*/
export interface Schema$StructuredResult {
/**
* Representation of a person
*/
person?: Schema$Person;
}
/**
* Request of suggest API.
*/
export interface Schema$SuggestRequest {
/**
* The sources to use for suggestions. If not specified, all data sources from the current search application are used. Suggestions are based on Gmail titles. Suggestions from third party sources are not available.
*/
dataSourceRestrictions?: Schema$DataSourceRestriction[];
/**
* Partial query for which autocomplete suggestions will be shown. For example, if the query is "sea", then the server might return "season", "search", "seagull" and so on.
*/
query?: string | null;
/**
* Request options, such as the search application and user timezone.
*/
requestOptions?: Schema$RequestOptions;
}
/**
* Response of the suggest API.
*/
export interface Schema$SuggestResponse {
/**
* List of suggestions.
*/
suggestResults?: Schema$SuggestResult[];
}
/**
* One suggestion result.
*/
export interface Schema$SuggestResult {
/**
* This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc.
*/
peopleSuggestion?: Schema$PeopleSuggestion;
/**
* This field will be present if the suggested query is a word/phrase completion.
*/
querySuggestion?: Schema$QuerySuggestion;
/**
* The source of the suggestion.
*/
source?: Schema$Source;
/**
* The suggested query that will be used for search, when the user clicks on the suggestion
*/
suggestedQuery?: string | null;
}
/**
* Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
*/
export interface Schema$TextOperatorOptions {
/**
* If true, the text value will be tokenized as one atomic value in operator searches and facet matches. For example, if the operator name is "genre" and the value is "science-fiction" the query restrictions "genre:science" and "genre:fiction" will not match the item; "genre:science-fiction" will. Value matching is case-sensitive and does not remove special characters. If false, the text will be tokenized. For example, if the value is "science-fiction" the queries "genre:science" and "genre:fiction" will match the item.
*/
exactMatchWithOperator?: boolean | null;
/**
* Indicates the operator name required in the query in order to isolate the text property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:&lt;value&gt;* will show results only where the value of the property named *subjectLine* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any text properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
operatorName?: string | null;
}
/**
* Options for text properties.
*/
export interface Schema$TextPropertyOptions {
/**
* If set, describes how the property should be used as a search operator.
*/
operatorOptions?: Schema$TextOperatorOptions;
/**
* Indicates the search quality importance of the tokens within the field when used for retrieval.
*/
retrievalImportance?: Schema$RetrievalImportance;
}
/**
* List of text values.
*/
export interface Schema$TextValues {
/**
* The maximum allowable length for text values is 2048 characters.
*/
values?: string[] | null;
}
/**
* Used to provide a search operator for timestamp properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
*/
export interface Schema$TimestampOperatorOptions {
/**
* Indicates the operator name required in the query in order to isolate the timestamp property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:&lt;value&gt;* will show results only where the value of the property named *closeDate* is later than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
greaterThanOperatorName?: string | null;
/**
* Indicates the operator name required in the query in order to isolate the timestamp property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:&lt;value&gt;* will show results only where the value of the property named *closeDate* is earlier than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
lessThanOperatorName?: string | null;
/**
* Indicates the operator name required in the query in order to isolate the timestamp property. For example, if operatorName is *closedon* and the property's name is *closeDate*, then queries like *closedon:&lt;value&gt;* will show results only where the value of the property named *closeDate* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
*/
operatorName?: string | null;
}
/**
* Options for timestamp properties.
*/
export interface Schema$TimestampPropertyOptions {
/**
* If set, describes how the timestamp should be used as a search operator.
*/
operatorOptions?: Schema$TimestampOperatorOptions;
}
/**
* List of timestamp values.
*/
export interface Schema$TimestampValues {
values?: string[] | null;
}
export interface Schema$UnmappedIdentity {
/**
* The resource name for an external user.
*/
externalIdentity?: Schema$Principal;
/**
* The resolution status for the external identity.
*/
resolutionStatusCode?: string | null;
}
export interface Schema$UnreserveItemsRequest {
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string | null;
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
/**
* Name of a queue to unreserve items from.
*/
queue?: string | null;
}
export interface Schema$UpdateDataSourceRequest {
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
source?: Schema$DataSource;
}
export interface Schema$UpdateSchemaRequest {
/**
* Common debug options.
*/
debugOptions?: Schema$DebugOptions;
/**
* The new schema for the source.
*/
schema?: Schema$Schema;
/**
* If true, the request will be validated without side effects.
*/
validateOnly?: boolean | null;
}
/**
* Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef.
*/
export interface Schema$UploadItemRef {
/**
* Name of the content reference. The maximum length is 2048 characters.
*/
name?: string | null;
}
/**
* Definition of a single value with generic type.
*/
export interface Schema$Value {
booleanValue?: boolean | null;
dateValue?: Schema$Date;
doubleValue?: number | null;
integerValue?: string | null;
stringValue?: string | null;
timestampValue?: string | null;
}
export interface Schema$ValueFilter {
/**
* The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: <br/><br/> 1. `operator_name`, where the query filters results by the property that matches the value. <br/> 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
*/
operatorName?: string | null;
/**
* The value to be compared with.
*/
value?: Schema$Value;
}
export class Resource$Debug {
context: APIRequestContext;
datasources: Resource$Debug$Datasources;
identitysources: Resource$Debug$Identitysources;
constructor(context: APIRequestContext);
}
export class Resource$Debug$Datasources {
context: APIRequestContext;
items: Resource$Debug$Datasources$Items;
constructor(context: APIRequestContext);
}
export class Resource$Debug$Datasources$Items {
context: APIRequestContext;
unmappedids: Resource$Debug$Datasources$Items$Unmappedids;
constructor(context: APIRequestContext);
/**
* cloudsearch.debug.datasources.items.checkAccess
* @desc Checks whether an item is accessible by specified principal.
* @alias cloudsearch.debug.datasources.items.checkAccess
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name Item name, format: datasources/{source_id}/items/{item_id}
* @param {().Principal} 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
*/
checkAccess(params?: Params$Resource$Debug$Datasources$Items$Checkaccess, options?: MethodOptions): GaxiosPromise<Schema$CheckAccessResponse>;
checkAccess(params: Params$Resource$Debug$Datasources$Items$Checkaccess, options: MethodOptions | BodyResponseCallback<Schema$CheckAccessResponse>, callback: BodyResponseCallback<Schema$CheckAccessResponse>): void;
checkAccess(params: Params$Resource$Debug$Datasources$Items$Checkaccess, callback: BodyResponseCallback<Schema$CheckAccessResponse>): void;
checkAccess(callback: BodyResponseCallback<Schema$CheckAccessResponse>): void;
/**
* cloudsearch.debug.datasources.items.searchByViewUrl
* @desc Fetches the item whose viewUrl exactly matches that of the URL provided in the request.
* @alias cloudsearch.debug.datasources.items.searchByViewUrl
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Source name, format: datasources/{source_id}
* @param {().SearchItemsByViewUrlRequest} 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
*/
searchByViewUrl(params?: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, options?: MethodOptions): GaxiosPromise<Schema$SearchItemsByViewUrlResponse>;
searchByViewUrl(params: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, options: MethodOptions | BodyResponseCallback<Schema$SearchItemsByViewUrlResponse>, callback: BodyResponseCallback<Schema$SearchItemsByViewUrlResponse>): void;
searchByViewUrl(params: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, callback: BodyResponseCallback<Schema$SearchItemsByViewUrlResponse>): void;
searchByViewUrl(callback: BodyResponseCallback<Schema$SearchItemsByViewUrlResponse>): void;
}
export interface Params$Resource$Debug$Datasources$Items$Checkaccess extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Item name, format: datasources/{source_id}/items/{item_id}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Principal;
}
export interface Params$Resource$Debug$Datasources$Items$Searchbyviewurl extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Source name, format: datasources/{source_id}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SearchItemsByViewUrlRequest;
}
export class Resource$Debug$Datasources$Items$Unmappedids {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.debug.datasources.items.unmappedids.list
* @desc List all unmapped identities for a specific item.
* @alias cloudsearch.debug.datasources.items.unmappedids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100.
* @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any.
* @param {string} params.parent The name of the item, in the following format: datasources/{source_id}/items/{ID}
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Debug$Datasources$Items$Unmappedids$List, options?: MethodOptions): GaxiosPromise<Schema$ListUnmappedIdentitiesResponse>;
list(params: Params$Resource$Debug$Datasources$Items$Unmappedids$List, options: MethodOptions | BodyResponseCallback<Schema$ListUnmappedIdentitiesResponse>, callback: BodyResponseCallback<Schema$ListUnmappedIdentitiesResponse>): void;
list(params: Params$Resource$Debug$Datasources$Items$Unmappedids$List, callback: BodyResponseCallback<Schema$ListUnmappedIdentitiesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListUnmappedIdentitiesResponse>): void;
}
export interface Params$Resource$Debug$Datasources$Items$Unmappedids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Maximum number of items to fetch in a request. Defaults to 100.
*/
pageSize?: number;
/**
* The next_page_token value returned from a previous List request, if any.
*/
pageToken?: string;
/**
* The name of the item, in the following format: datasources/{source_id}/items/{ID}
*/
parent?: string;
}
export class Resource$Debug$Identitysources {
context: APIRequestContext;
items: Resource$Debug$Identitysources$Items;
unmappedids: Resource$Debug$Identitysources$Unmappedids;
constructor(context: APIRequestContext);
}
export class Resource$Debug$Identitysources$Items {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.debug.identitysources.items.listForunmappedidentity
* @desc Lists names of items associated with an unmapped identity.
* @alias cloudsearch.debug.identitysources.items.listForunmappedidentity
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string=} params.groupResourceName
* @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100.
* @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any.
* @param {string} params.parent The name of the identity source, in the following format: identitysources/{source_id}}
* @param {string=} params.userResourceName
* @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
*/
listForunmappedidentity(params?: Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, options?: MethodOptions): GaxiosPromise<Schema$ListItemNamesForUnmappedIdentityResponse>;
listForunmappedidentity(params: Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, options: MethodOptions | BodyResponseCallback<Schema$ListItemNamesForUnmappedIdentityResponse>, callback: BodyResponseCallback<Schema$ListItemNamesForUnmappedIdentityResponse>): void;
listForunmappedidentity(params: Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, callback: BodyResponseCallback<Schema$ListItemNamesForUnmappedIdentityResponse>): void;
listForunmappedidentity(callback: BodyResponseCallback<Schema$ListItemNamesForUnmappedIdentityResponse>): void;
}
export interface Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
*
*/
groupResourceName?: string;
/**
* Maximum number of items to fetch in a request. Defaults to 100.
*/
pageSize?: number;
/**
* The next_page_token value returned from a previous List request, if any.
*/
pageToken?: string;
/**
* The name of the identity source, in the following format: identitysources/{source_id}}
*/
parent?: string;
/**
*
*/
userResourceName?: string;
}
export class Resource$Debug$Identitysources$Unmappedids {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.debug.identitysources.unmappedids.list
* @desc Lists unmapped user identities for an identity source.
* @alias cloudsearch.debug.identitysources.unmappedids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100.
* @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any.
* @param {string} params.parent The name of the identity source, in the following format: identitysources/{source_id}
* @param {string=} params.resolutionStatusCode Limit users selection to this status.
* @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$Debug$Identitysources$Unmappedids$List, options?: MethodOptions): GaxiosPromise<Schema$ListUnmappedIdentitiesResponse>;
list(params: Params$Resource$Debug$Identitysources$Unmappedids$List, options: MethodOptions | BodyResponseCallback<Schema$ListUnmappedIdentitiesResponse>, callback: BodyResponseCallback<Schema$ListUnmappedIdentitiesResponse>): void;
list(params: Params$Resource$Debug$Identitysources$Unmappedids$List, callback: BodyResponseCallback<Schema$ListUnmappedIdentitiesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListUnmappedIdentitiesResponse>): void;
}
export interface Params$Resource$Debug$Identitysources$Unmappedids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Maximum number of items to fetch in a request. Defaults to 100.
*/
pageSize?: number;
/**
* The next_page_token value returned from a previous List request, if any.
*/
pageToken?: string;
/**
* The name of the identity source, in the following format: identitysources/{source_id}
*/
parent?: string;
/**
* Limit users selection to this status.
*/
resolutionStatusCode?: string;
}
export class Resource$Indexing {
context: APIRequestContext;
datasources: Resource$Indexing$Datasources;
constructor(context: APIRequestContext);
}
export class Resource$Indexing$Datasources {
context: APIRequestContext;
items: Resource$Indexing$Datasources$Items;
constructor(context: APIRequestContext);
/**
* cloudsearch.indexing.datasources.deleteSchema
* @desc Deletes the schema of a data source.
* @alias cloudsearch.indexing.datasources.deleteSchema
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name Name of the data source to delete Schema. Format: datasources/{source_id}
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
deleteSchema(params?: Params$Resource$Indexing$Datasources$Deleteschema, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
deleteSchema(params: Params$Resource$Indexing$Datasources$Deleteschema, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
deleteSchema(params: Params$Resource$Indexing$Datasources$Deleteschema, callback: BodyResponseCallback<Schema$Operation>): void;
deleteSchema(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.indexing.datasources.getSchema
* @desc Gets the schema of a data source.
* @alias cloudsearch.indexing.datasources.getSchema
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name Name of the data source to get Schema. Format: datasources/{source_id}
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getSchema(params?: Params$Resource$Indexing$Datasources$Getschema, options?: MethodOptions): GaxiosPromise<Schema$Schema>;
getSchema(params: Params$Resource$Indexing$Datasources$Getschema, options: MethodOptions | BodyResponseCallback<Schema$Schema>, callback: BodyResponseCallback<Schema$Schema>): void;
getSchema(params: Params$Resource$Indexing$Datasources$Getschema, callback: BodyResponseCallback<Schema$Schema>): void;
getSchema(callback: BodyResponseCallback<Schema$Schema>): void;
/**
* cloudsearch.indexing.datasources.updateSchema
* @desc Updates the schema of a data source.
* @alias cloudsearch.indexing.datasources.updateSchema
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the data source to update Schema. Format: datasources/{source_id}
* @param {().UpdateSchemaRequest} 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
*/
updateSchema(params?: Params$Resource$Indexing$Datasources$Updateschema, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
updateSchema(params: Params$Resource$Indexing$Datasources$Updateschema, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
updateSchema(params: Params$Resource$Indexing$Datasources$Updateschema, callback: BodyResponseCallback<Schema$Operation>): void;
updateSchema(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Indexing$Datasources$Deleteschema extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Name of the data source to delete Schema. Format: datasources/{source_id}
*/
name?: string;
}
export interface Params$Resource$Indexing$Datasources$Getschema extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Name of the data source to get Schema. Format: datasources/{source_id}
*/
name?: string;
}
export interface Params$Resource$Indexing$Datasources$Updateschema extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the data source to update Schema. Format: datasources/{source_id}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateSchemaRequest;
}
export class Resource$Indexing$Datasources$Items {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.indexing.datasources.items.delete
* @desc Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.connectorName Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string=} params.mode Required. The RequestMode for this request.
* @param {string} params.name Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id}
* @param {string=} params.version Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. <br /><br /> Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
* @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$Indexing$Datasources$Items$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Indexing$Datasources$Items$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Indexing$Datasources$Items$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.indexing.datasources.items.deleteQueueItems
* @desc Deletes all items in a queue. This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.deleteQueueItems
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the Data Source to delete items in a queue. Format: datasources/{source_id}
* @param {().DeleteQueueItemsRequest} 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
*/
deleteQueueItems(params?: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
deleteQueueItems(params: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
deleteQueueItems(params: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, callback: BodyResponseCallback<Schema$Operation>): void;
deleteQueueItems(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.indexing.datasources.items.get
* @desc Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.connectorName Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name Name of the item to get info. Format: datasources/{source_id}/items/{item_id}
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Indexing$Datasources$Items$Get, options?: MethodOptions): GaxiosPromise<Schema$Item>;
get(params: Params$Resource$Indexing$Datasources$Items$Get, options: MethodOptions | BodyResponseCallback<Schema$Item>, callback: BodyResponseCallback<Schema$Item>): void;
get(params: Params$Resource$Indexing$Datasources$Items$Get, callback: BodyResponseCallback<Schema$Item>): void;
get(callback: BodyResponseCallback<Schema$Item>): void;
/**
* cloudsearch.indexing.datasources.items.index
* @desc Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.index
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the Item. Format: datasources/{source_id}/items/{item_id} <br />This is a required field. The maximum length is 1536 characters.
* @param {().IndexItemRequest} 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
*/
index(params?: Params$Resource$Indexing$Datasources$Items$Index, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
index(params: Params$Resource$Indexing$Datasources$Items$Index, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
index(params: Params$Resource$Indexing$Datasources$Items$Index, callback: BodyResponseCallback<Schema$Operation>): void;
index(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.indexing.datasources.items.list
* @desc Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.brief When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, <br />If this value is false, then all the fields are populated in Item.
* @param {string=} params.connectorName Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name Name of the Data Source to list Items. Format: datasources/{source_id}
* @param {integer=} params.pageSize Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false. <br />The default value is 10
* @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any.
* @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$Indexing$Datasources$Items$List, options?: MethodOptions): GaxiosPromise<Schema$ListItemsResponse>;
list(params: Params$Resource$Indexing$Datasources$Items$List, options: MethodOptions | BodyResponseCallback<Schema$ListItemsResponse>, callback: BodyResponseCallback<Schema$ListItemsResponse>): void;
list(params: Params$Resource$Indexing$Datasources$Items$List, callback: BodyResponseCallback<Schema$ListItemsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListItemsResponse>): void;
/**
* cloudsearch.indexing.datasources.items.poll
* @desc Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows: <br /> ERROR <br /> MODIFIED <br /> NEW_ITEM <br /> ACCEPTED <br /> Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.poll
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the Data Source to poll items. Format: datasources/{source_id}
* @param {().PollItemsRequest} 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
*/
poll(params?: Params$Resource$Indexing$Datasources$Items$Poll, options?: MethodOptions): GaxiosPromise<Schema$PollItemsResponse>;
poll(params: Params$Resource$Indexing$Datasources$Items$Poll, options: MethodOptions | BodyResponseCallback<Schema$PollItemsResponse>, callback: BodyResponseCallback<Schema$PollItemsResponse>): void;
poll(params: Params$Resource$Indexing$Datasources$Items$Poll, callback: BodyResponseCallback<Schema$PollItemsResponse>): void;
poll(callback: BodyResponseCallback<Schema$PollItemsResponse>): void;
/**
* cloudsearch.indexing.datasources.items.push
* @desc Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.push
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the item to push into the indexing queue.<br /> Format: datasources/{source_id}/items/{ID} <br />This is a required field. The maximum length is 1536 characters.
* @param {().PushItemRequest} 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
*/
push(params?: Params$Resource$Indexing$Datasources$Items$Push, options?: MethodOptions): GaxiosPromise<Schema$Item>;
push(params: Params$Resource$Indexing$Datasources$Items$Push, options: MethodOptions | BodyResponseCallback<Schema$Item>, callback: BodyResponseCallback<Schema$Item>): void;
push(params: Params$Resource$Indexing$Datasources$Items$Push, callback: BodyResponseCallback<Schema$Item>): void;
push(callback: BodyResponseCallback<Schema$Item>): void;
/**
* cloudsearch.indexing.datasources.items.unreserve
* @desc Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.unreserve
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the Data Source to unreserve all items. Format: datasources/{source_id}
* @param {().UnreserveItemsRequest} 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
*/
unreserve(params?: Params$Resource$Indexing$Datasources$Items$Unreserve, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
unreserve(params: Params$Resource$Indexing$Datasources$Items$Unreserve, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
unreserve(params: Params$Resource$Indexing$Datasources$Items$Unreserve, callback: BodyResponseCallback<Schema$Operation>): void;
unreserve(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.indexing.datasources.items.upload
* @desc Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
* @alias cloudsearch.indexing.datasources.items.upload
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}.
* @param {().StartUploadItemRequest} 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
*/
upload(params?: Params$Resource$Indexing$Datasources$Items$Upload, options?: MethodOptions): GaxiosPromise<Schema$UploadItemRef>;
upload(params: Params$Resource$Indexing$Datasources$Items$Upload, options: MethodOptions | BodyResponseCallback<Schema$UploadItemRef>, callback: BodyResponseCallback<Schema$UploadItemRef>): void;
upload(params: Params$Resource$Indexing$Datasources$Items$Upload, callback: BodyResponseCallback<Schema$UploadItemRef>): void;
upload(callback: BodyResponseCallback<Schema$UploadItemRef>): void;
}
export interface Params$Resource$Indexing$Datasources$Items$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Required. The RequestMode for this request.
*/
mode?: string;
/**
* Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id}
*/
name?: string;
/**
* Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. <br /><br /> Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
*/
version?: string;
}
export interface Params$Resource$Indexing$Datasources$Items$Deletequeueitems extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the Data Source to delete items in a queue. Format: datasources/{source_id}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DeleteQueueItemsRequest;
}
export interface Params$Resource$Indexing$Datasources$Items$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Name of the item to get info. Format: datasources/{source_id}/items/{item_id}
*/
name?: string;
}
export interface Params$Resource$Indexing$Datasources$Items$Index extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the Item. Format: datasources/{source_id}/items/{item_id} <br />This is a required field. The maximum length is 1536 characters.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$IndexItemRequest;
}
export interface Params$Resource$Indexing$Datasources$Items$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, <br />If this value is false, then all the fields are populated in Item.
*/
brief?: boolean;
/**
* Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID}
*/
connectorName?: string;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Name of the Data Source to list Items. Format: datasources/{source_id}
*/
name?: string;
/**
* Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false. <br />The default value is 10
*/
pageSize?: number;
/**
* The next_page_token value returned from a previous List request, if any.
*/
pageToken?: string;
}
export interface Params$Resource$Indexing$Datasources$Items$Poll extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the Data Source to poll items. Format: datasources/{source_id}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PollItemsRequest;
}
export interface Params$Resource$Indexing$Datasources$Items$Push extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the item to push into the indexing queue.<br /> Format: datasources/{source_id}/items/{ID} <br />This is a required field. The maximum length is 1536 characters.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PushItemRequest;
}
export interface Params$Resource$Indexing$Datasources$Items$Unreserve extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the Data Source to unreserve all items. Format: datasources/{source_id}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UnreserveItemsRequest;
}
export interface Params$Resource$Indexing$Datasources$Items$Upload extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$StartUploadItemRequest;
}
export class Resource$Media {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.media.upload
* @desc Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the resource name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content using the same resource name from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest).
* @alias cloudsearch.media.upload
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resourceName Name of the media that is being downloaded. See ReadRequest.resource_name.
* @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
*/
upload(params?: Params$Resource$Media$Upload, options?: MethodOptions): GaxiosPromise<Schema$Media>;
upload(params: Params$Resource$Media$Upload, options: MethodOptions | BodyResponseCallback<Schema$Media>, callback: BodyResponseCallback<Schema$Media>): void;
upload(params: Params$Resource$Media$Upload, callback: BodyResponseCallback<Schema$Media>): void;
upload(callback: BodyResponseCallback<Schema$Media>): void;
}
export interface Params$Resource$Media$Upload extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the media that is being downloaded. See ReadRequest.resource_name.
*/
resourceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Media;
/**
* Media metadata
*/
media?: {
/**
* Media mime-type
*/
mimeType?: string;
/**
* Media body contents
*/
body?: any;
};
}
export class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias cloudsearch.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @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$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
export class Resource$Query {
context: APIRequestContext;
sources: Resource$Query$Sources;
constructor(context: APIRequestContext);
/**
* cloudsearch.query.search
* @desc The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party.
* @alias cloudsearch.query.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SearchRequest} 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
*/
search(params?: Params$Resource$Query$Search, options?: MethodOptions): GaxiosPromise<Schema$SearchResponse>;
search(params: Params$Resource$Query$Search, options: MethodOptions | BodyResponseCallback<Schema$SearchResponse>, callback: BodyResponseCallback<Schema$SearchResponse>): void;
search(params: Params$Resource$Query$Search, callback: BodyResponseCallback<Schema$SearchResponse>): void;
search(callback: BodyResponseCallback<Schema$SearchResponse>): void;
/**
* cloudsearch.query.suggest
* @desc Provides suggestions for autocompleting the query.
* @alias cloudsearch.query.suggest
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SuggestRequest} 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
*/
suggest(params?: Params$Resource$Query$Suggest, options?: MethodOptions): GaxiosPromise<Schema$SuggestResponse>;
suggest(params: Params$Resource$Query$Suggest, options: MethodOptions | BodyResponseCallback<Schema$SuggestResponse>, callback: BodyResponseCallback<Schema$SuggestResponse>): void;
suggest(params: Params$Resource$Query$Suggest, callback: BodyResponseCallback<Schema$SuggestResponse>): void;
suggest(callback: BodyResponseCallback<Schema$SuggestResponse>): void;
}
export interface Params$Resource$Query$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SearchRequest;
}
export interface Params$Resource$Query$Suggest extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SuggestRequest;
}
export class Resource$Query$Sources {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.query.sources.list
* @desc Returns list of sources that user can use for Search and Suggest APIs.
* @alias cloudsearch.query.sources.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.pageToken Number of sources to return in the response.
* @param {boolean=} params.requestOptions.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string=} params.requestOptions.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.
* @param {string=} params.requestOptions.searchApplicationId Id of the application created using SearchApplicationsService.
* @param {string=} params.requestOptions.timeZone Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
* @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$Query$Sources$List, options?: MethodOptions): GaxiosPromise<Schema$ListQuerySourcesResponse>;
list(params: Params$Resource$Query$Sources$List, options: MethodOptions | BodyResponseCallback<Schema$ListQuerySourcesResponse>, callback: BodyResponseCallback<Schema$ListQuerySourcesResponse>): void;
list(params: Params$Resource$Query$Sources$List, callback: BodyResponseCallback<Schema$ListQuerySourcesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListQuerySourcesResponse>): void;
}
export interface Params$Resource$Query$Sources$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Number of sources to return in the response.
*/
pageToken?: string;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'requestOptions.debugOptions.enableDebugging'?: boolean;
/**
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.
*/
'requestOptions.languageCode'?: string;
/**
* Id of the application created using SearchApplicationsService.
*/
'requestOptions.searchApplicationId'?: string;
/**
* Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
*/
'requestOptions.timeZone'?: string;
}
export class Resource$Settings {
context: APIRequestContext;
datasources: Resource$Settings$Datasources;
searchapplications: Resource$Settings$Searchapplications;
constructor(context: APIRequestContext);
}
export class Resource$Settings$Datasources {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.settings.datasources.create
* @desc Creates a datasource.
* @alias cloudsearch.settings.datasources.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().DataSource} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Settings$Datasources$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Settings$Datasources$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Settings$Datasources$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.settings.datasources.delete
* @desc Deletes a datasource.
* @alias cloudsearch.settings.datasources.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name Name of the datasource. Format: datasources/{source_id}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Settings$Datasources$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Settings$Datasources$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Settings$Datasources$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.settings.datasources.get
* @desc Gets a datasource.
* @alias cloudsearch.settings.datasources.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name Name of the datasource resource. Format: datasources/{source_id}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Settings$Datasources$Get, options?: MethodOptions): GaxiosPromise<Schema$DataSource>;
get(params: Params$Resource$Settings$Datasources$Get, options: MethodOptions | BodyResponseCallback<Schema$DataSource>, callback: BodyResponseCallback<Schema$DataSource>): void;
get(params: Params$Resource$Settings$Datasources$Get, callback: BodyResponseCallback<Schema$DataSource>): void;
get(callback: BodyResponseCallback<Schema$DataSource>): void;
/**
* cloudsearch.settings.datasources.list
* @desc Lists datasources.
* @alias cloudsearch.settings.datasources.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {integer=} params.pageSize Maximum number of datasources to fetch in a request. The max value is 100. <br />The default value is 10
* @param {string=} params.pageToken Starting index of the 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$Settings$Datasources$List, options?: MethodOptions): GaxiosPromise<Schema$ListDataSourceResponse>;
list(params: Params$Resource$Settings$Datasources$List, options: MethodOptions | BodyResponseCallback<Schema$ListDataSourceResponse>, callback: BodyResponseCallback<Schema$ListDataSourceResponse>): void;
list(params: Params$Resource$Settings$Datasources$List, callback: BodyResponseCallback<Schema$ListDataSourceResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDataSourceResponse>): void;
/**
* cloudsearch.settings.datasources.update
* @desc Updates a datasource.
* @alias cloudsearch.settings.datasources.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the datasource resource. Format: datasources/{source_id}. <br />The name is ignored when creating a datasource.
* @param {().UpdateDataSourceRequest} 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$Settings$Datasources$Update, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
update(params: Params$Resource$Settings$Datasources$Update, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
update(params: Params$Resource$Settings$Datasources$Update, callback: BodyResponseCallback<Schema$Operation>): void;
update(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Settings$Datasources$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$DataSource;
}
export interface Params$Resource$Settings$Datasources$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Name of the datasource. Format: datasources/{source_id}.
*/
name?: string;
}
export interface Params$Resource$Settings$Datasources$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Name of the datasource resource. Format: datasources/{source_id}.
*/
name?: string;
}
export interface Params$Resource$Settings$Datasources$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Maximum number of datasources to fetch in a request. The max value is 100. <br />The default value is 10
*/
pageSize?: number;
/**
* Starting index of the results.
*/
pageToken?: string;
}
export interface Params$Resource$Settings$Datasources$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the datasource resource. Format: datasources/{source_id}. <br />The name is ignored when creating a datasource.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateDataSourceRequest;
}
export class Resource$Settings$Searchapplications {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.settings.searchapplications.create
* @desc Creates a search application.
* @alias cloudsearch.settings.searchapplications.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SearchApplication} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Settings$Searchapplications$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Settings$Searchapplications$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Settings$Searchapplications$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.settings.searchapplications.delete
* @desc Deletes a search application.
* @alias cloudsearch.settings.searchapplications.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name The name of the search application to be deleted. <br />Format: applications/{application_id}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Settings$Searchapplications$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Settings$Searchapplications$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Settings$Searchapplications$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.settings.searchapplications.get
* @desc Gets the specified search application.
* @alias cloudsearch.settings.searchapplications.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {string} params.name Name of the search application. <br />Format: applications/{application_id}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Settings$Searchapplications$Get, options?: MethodOptions): GaxiosPromise<Schema$SearchApplication>;
get(params: Params$Resource$Settings$Searchapplications$Get, options: MethodOptions | BodyResponseCallback<Schema$SearchApplication>, callback: BodyResponseCallback<Schema$SearchApplication>): void;
get(params: Params$Resource$Settings$Searchapplications$Get, callback: BodyResponseCallback<Schema$SearchApplication>): void;
get(callback: BodyResponseCallback<Schema$SearchApplication>): void;
/**
* cloudsearch.settings.searchapplications.list
* @desc Lists all search applications.
* @alias cloudsearch.settings.searchapplications.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
* @param {integer=} params.pageSize The maximum number of items to return.
* @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. <br/> The default value is 10
* @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$Settings$Searchapplications$List, options?: MethodOptions): GaxiosPromise<Schema$ListSearchApplicationsResponse>;
list(params: Params$Resource$Settings$Searchapplications$List, options: MethodOptions | BodyResponseCallback<Schema$ListSearchApplicationsResponse>, callback: BodyResponseCallback<Schema$ListSearchApplicationsResponse>): void;
list(params: Params$Resource$Settings$Searchapplications$List, callback: BodyResponseCallback<Schema$ListSearchApplicationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListSearchApplicationsResponse>): void;
/**
* cloudsearch.settings.searchapplications.reset
* @desc Resets a search application to default settings. This will return an empty response.
* @alias cloudsearch.settings.searchapplications.reset
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the search application to be reset. <br />Format: applications/{application_id}.
* @param {().ResetSearchApplicationRequest} 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
*/
reset(params?: Params$Resource$Settings$Searchapplications$Reset, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
reset(params: Params$Resource$Settings$Searchapplications$Reset, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
reset(params: Params$Resource$Settings$Searchapplications$Reset, callback: BodyResponseCallback<Schema$Operation>): void;
reset(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudsearch.settings.searchapplications.update
* @desc Updates a search application.
* @alias cloudsearch.settings.searchapplications.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the Search Application. <br />Format: searchapplications/{application_id}.
* @param {().SearchApplication} 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$Settings$Searchapplications$Update, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
update(params: Params$Resource$Settings$Searchapplications$Update, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
update(params: Params$Resource$Settings$Searchapplications$Update, callback: BodyResponseCallback<Schema$Operation>): void;
update(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Settings$Searchapplications$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SearchApplication;
}
export interface Params$Resource$Settings$Searchapplications$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* The name of the search application to be deleted. <br />Format: applications/{application_id}.
*/
name?: string;
}
export interface Params$Resource$Settings$Searchapplications$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* Name of the search application. <br />Format: applications/{application_id}.
*/
name?: string;
}
export interface Params$Resource$Settings$Searchapplications$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
*/
'debugOptions.enableDebugging'?: boolean;
/**
* The maximum number of items to return.
*/
pageSize?: number;
/**
* The next_page_token value returned from a previous List request, if any. <br/> The default value is 10
*/
pageToken?: string;
}
export interface Params$Resource$Settings$Searchapplications$Reset extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the search application to be reset. <br />Format: applications/{application_id}.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ResetSearchApplicationRequest;
}
export interface Params$Resource$Settings$Searchapplications$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the Search Application. <br />Format: searchapplications/{application_id}.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SearchApplication;
}
export class Resource$Stats {
context: APIRequestContext;
index: Resource$Stats$Index;
query: Resource$Stats$Query;
session: Resource$Stats$Session;
user: Resource$Stats$User;
constructor(context: APIRequestContext);
/**
* cloudsearch.stats.getIndex
* @desc Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day.
* @alias cloudsearch.stats.getIndex
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999.
* @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.toDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999.
* @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
*/
getIndex(params?: Params$Resource$Stats$Getindex, options?: MethodOptions): GaxiosPromise<Schema$GetCustomerIndexStatsResponse>;
getIndex(params: Params$Resource$Stats$Getindex, options: MethodOptions | BodyResponseCallback<Schema$GetCustomerIndexStatsResponse>, callback: BodyResponseCallback<Schema$GetCustomerIndexStatsResponse>): void;
getIndex(params: Params$Resource$Stats$Getindex, callback: BodyResponseCallback<Schema$GetCustomerIndexStatsResponse>): void;
getIndex(callback: BodyResponseCallback<Schema$GetCustomerIndexStatsResponse>): void;
/**
* cloudsearch.stats.getQuery
* @desc Get the query statistics for customer
* @alias cloudsearch.stats.getQuery
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999.
* @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.toDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999.
* @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
*/
getQuery(params?: Params$Resource$Stats$Getquery, options?: MethodOptions): GaxiosPromise<Schema$GetCustomerQueryStatsResponse>;
getQuery(params: Params$Resource$Stats$Getquery, options: MethodOptions | BodyResponseCallback<Schema$GetCustomerQueryStatsResponse>, callback: BodyResponseCallback<Schema$GetCustomerQueryStatsResponse>): void;
getQuery(params: Params$Resource$Stats$Getquery, callback: BodyResponseCallback<Schema$GetCustomerQueryStatsResponse>): void;
getQuery(callback: BodyResponseCallback<Schema$GetCustomerQueryStatsResponse>): void;
/**
* cloudsearch.stats.getSession
* @desc Get the # of search sessions for the customer
* @alias cloudsearch.stats.getSession
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999.
* @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.toDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999.
* @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
*/
getSession(params?: Params$Resource$Stats$Getsession, options?: MethodOptions): GaxiosPromise<Schema$GetCustomerSessionStatsResponse>;
getSession(params: Params$Resource$Stats$Getsession, options: MethodOptions | BodyResponseCallback<Schema$GetCustomerSessionStatsResponse>, callback: BodyResponseCallback<Schema$GetCustomerSessionStatsResponse>): void;
getSession(params: Params$Resource$Stats$Getsession, callback: BodyResponseCallback<Schema$GetCustomerSessionStatsResponse>): void;
getSession(callback: BodyResponseCallback<Schema$GetCustomerSessionStatsResponse>): void;
/**
* cloudsearch.stats.getUser
* @desc Get the users statistics for customer
* @alias cloudsearch.stats.getUser
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999.
* @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.toDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999.
* @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
*/
getUser(params?: Params$Resource$Stats$Getuser, options?: MethodOptions): GaxiosPromise<Schema$GetCustomerUserStatsResponse>;
getUser(params: Params$Resource$Stats$Getuser, options: MethodOptions | BodyResponseCallback<Schema$GetCustomerUserStatsResponse>, callback: BodyResponseCallback<Schema$GetCustomerUserStatsResponse>): void;
getUser(params: Params$Resource$Stats$Getuser, callback: BodyResponseCallback<Schema$GetCustomerUserStatsResponse>): void;
getUser(callback: BodyResponseCallback<Schema$GetCustomerUserStatsResponse>): void;
}
export interface Params$Resource$Stats$Getindex extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'fromDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'fromDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'fromDate.year'?: number;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'toDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'toDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'toDate.year'?: number;
}
export interface Params$Resource$Stats$Getquery extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'fromDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'fromDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'fromDate.year'?: number;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'toDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'toDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'toDate.year'?: number;
}
export interface Params$Resource$Stats$Getsession extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'fromDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'fromDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'fromDate.year'?: number;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'toDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'toDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'toDate.year'?: number;
}
export interface Params$Resource$Stats$Getuser extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'fromDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'fromDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'fromDate.year'?: number;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'toDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'toDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'toDate.year'?: number;
}
export class Resource$Stats$Index {
context: APIRequestContext;
datasources: Resource$Stats$Index$Datasources;
constructor(context: APIRequestContext);
}
export class Resource$Stats$Index$Datasources {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.stats.index.datasources.get
* @desc Gets indexed item statistics for a single data source.
* @alias cloudsearch.stats.index.datasources.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999.
* @param {string} params.name The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}"
* @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.toDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999.
* @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$Stats$Index$Datasources$Get, options?: MethodOptions): GaxiosPromise<Schema$GetDataSourceIndexStatsResponse>;
get(params: Params$Resource$Stats$Index$Datasources$Get, options: MethodOptions | BodyResponseCallback<Schema$GetDataSourceIndexStatsResponse>, callback: BodyResponseCallback<Schema$GetDataSourceIndexStatsResponse>): void;
get(params: Params$Resource$Stats$Index$Datasources$Get, callback: BodyResponseCallback<Schema$GetDataSourceIndexStatsResponse>): void;
get(callback: BodyResponseCallback<Schema$GetDataSourceIndexStatsResponse>): void;
}
export interface Params$Resource$Stats$Index$Datasources$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'fromDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'fromDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'fromDate.year'?: number;
/**
* The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}"
*/
name?: string;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'toDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'toDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'toDate.year'?: number;
}
export class Resource$Stats$Query {
context: APIRequestContext;
searchapplications: Resource$Stats$Query$Searchapplications;
constructor(context: APIRequestContext);
}
export class Resource$Stats$Query$Searchapplications {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.stats.query.searchapplications.get
* @desc Get the query statistics for search application
* @alias cloudsearch.stats.query.searchapplications.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999.
* @param {string} params.name The resource id of the search application query stats, in the following format: searchapplications/{application_id}
* @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.toDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999.
* @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$Stats$Query$Searchapplications$Get, options?: MethodOptions): GaxiosPromise<Schema$GetSearchApplicationQueryStatsResponse>;
get(params: Params$Resource$Stats$Query$Searchapplications$Get, options: MethodOptions | BodyResponseCallback<Schema$GetSearchApplicationQueryStatsResponse>, callback: BodyResponseCallback<Schema$GetSearchApplicationQueryStatsResponse>): void;
get(params: Params$Resource$Stats$Query$Searchapplications$Get, callback: BodyResponseCallback<Schema$GetSearchApplicationQueryStatsResponse>): void;
get(callback: BodyResponseCallback<Schema$GetSearchApplicationQueryStatsResponse>): void;
}
export interface Params$Resource$Stats$Query$Searchapplications$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'fromDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'fromDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'fromDate.year'?: number;
/**
* The resource id of the search application query stats, in the following format: searchapplications/{application_id}
*/
name?: string;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'toDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'toDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'toDate.year'?: number;
}
export class Resource$Stats$Session {
context: APIRequestContext;
searchapplications: Resource$Stats$Session$Searchapplications;
constructor(context: APIRequestContext);
}
export class Resource$Stats$Session$Searchapplications {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.stats.session.searchapplications.get
* @desc Get the # of search sessions for the search application
* @alias cloudsearch.stats.session.searchapplications.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999.
* @param {string} params.name The resource id of the search application session stats, in the following format: searchapplications/{application_id}
* @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.toDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999.
* @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$Stats$Session$Searchapplications$Get, options?: MethodOptions): GaxiosPromise<Schema$GetSearchApplicationSessionStatsResponse>;
get(params: Params$Resource$Stats$Session$Searchapplications$Get, options: MethodOptions | BodyResponseCallback<Schema$GetSearchApplicationSessionStatsResponse>, callback: BodyResponseCallback<Schema$GetSearchApplicationSessionStatsResponse>): void;
get(params: Params$Resource$Stats$Session$Searchapplications$Get, callback: BodyResponseCallback<Schema$GetSearchApplicationSessionStatsResponse>): void;
get(callback: BodyResponseCallback<Schema$GetSearchApplicationSessionStatsResponse>): void;
}
export interface Params$Resource$Stats$Session$Searchapplications$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'fromDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'fromDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'fromDate.year'?: number;
/**
* The resource id of the search application session stats, in the following format: searchapplications/{application_id}
*/
name?: string;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'toDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'toDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'toDate.year'?: number;
}
export class Resource$Stats$User {
context: APIRequestContext;
searchapplications: Resource$Stats$User$Searchapplications;
constructor(context: APIRequestContext);
}
export class Resource$Stats$User$Searchapplications {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudsearch.stats.user.searchapplications.get
* @desc Get the users statistics for search application
* @alias cloudsearch.stats.user.searchapplications.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999.
* @param {string} params.name The resource id of the search application session stats, in the following format: searchapplications/{application_id}
* @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month.
* @param {integer=} params.toDate.month Month of date. Must be from 1 to 12.
* @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999.
* @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$Stats$User$Searchapplications$Get, options?: MethodOptions): GaxiosPromise<Schema$GetSearchApplicationUserStatsResponse>;
get(params: Params$Resource$Stats$User$Searchapplications$Get, options: MethodOptions | BodyResponseCallback<Schema$GetSearchApplicationUserStatsResponse>, callback: BodyResponseCallback<Schema$GetSearchApplicationUserStatsResponse>): void;
get(params: Params$Resource$Stats$User$Searchapplications$Get, callback: BodyResponseCallback<Schema$GetSearchApplicationUserStatsResponse>): void;
get(callback: BodyResponseCallback<Schema$GetSearchApplicationUserStatsResponse>): void;
}
export interface Params$Resource$Stats$User$Searchapplications$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'fromDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'fromDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'fromDate.year'?: number;
/**
* The resource id of the search application session stats, in the following format: searchapplications/{application_id}
*/
name?: string;
/**
* Day of month. Must be from 1 to 31 and valid for the year and month.
*/
'toDate.day'?: number;
/**
* Month of date. Must be from 1 to 12.
*/
'toDate.month'?: number;
/**
* Year of date. Must be from 1 to 9999.
*/
'toDate.year'?: number;
}
export {};
}