v4.d.ts
184 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
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace jobs_v4 {
export interface Options extends GlobalOptions {
version: 'v4';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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 Talent Solution API
*
* Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.
*
* @example
* ```js
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
* ```
*/
export class Jobs {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Application related details of a job posting.
*/
export interface Schema$ApplicationInfo {
/**
* Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255.
*/
emails?: string[] | null;
/**
* Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000.
*/
instruction?: string | null;
/**
* Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.
*/
uris?: string[] | null;
}
/**
* Request to create a batch of jobs.
*/
export interface Schema$BatchCreateJobsRequest {
/**
* Required. The jobs to be created. A maximum of 200 jobs can be created in a batch.
*/
jobs?: Schema$Job[];
}
/**
* The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.
*/
export interface Schema$BatchCreateJobsResponse {
/**
* List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED.
*/
jobResults?: Schema$JobResult[];
}
/**
* Request to delete a batch of jobs.
*/
export interface Schema$BatchDeleteJobsRequest {
/**
* The names of the jobs to delete. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz". A maximum of 200 jobs can be deleted in a batch.
*/
names?: string[] | null;
}
/**
* The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.
*/
export interface Schema$BatchDeleteJobsResponse {
/**
* List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED.
*/
jobResults?: Schema$JobResult[];
}
/**
* Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.
*/
export interface Schema$BatchOperationMetadata {
/**
* The time when the batch operation is created.
*/
createTime?: string | null;
/**
* The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`.
*/
endTime?: string | null;
/**
* Count of failed item(s) inside an operation.
*/
failureCount?: number | null;
/**
* The state of a long running operation.
*/
state?: string | null;
/**
* More detailed information about operation state.
*/
stateDescription?: string | null;
/**
* Count of successful item(s) inside an operation.
*/
successCount?: number | null;
/**
* Count of total item(s) inside an operation.
*/
totalCount?: number | null;
/**
* The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.
*/
updateTime?: string | null;
}
/**
* Request to update a batch of jobs.
*/
export interface Schema$BatchUpdateJobsRequest {
/**
* Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch.
*/
jobs?: Schema$Job[];
/**
* Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation. If update_mask is provided, only the specified fields in Job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. If update_mask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.
*/
updateMask?: string | null;
}
/**
* The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.
*/
export interface Schema$BatchUpdateJobsResponse {
/**
* List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED.
*/
jobResults?: Schema$JobResult[];
}
/**
* An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.
*/
export interface Schema$ClientEvent {
/**
* Required. The timestamp of the event.
*/
createTime?: string | null;
/**
* Required. A unique identifier, generated by the client application.
*/
eventId?: string | null;
/**
* Notes about the event provided by recruiters or other users, for example, feedback on why a job was bookmarked.
*/
eventNotes?: string | null;
/**
* An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
*/
jobEvent?: Schema$JobEvent;
/**
* Strongly recommended for the best service experience. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.
*/
requestId?: string | null;
}
/**
* Parameters needed for commute search.
*/
export interface Schema$CommuteFilter {
/**
* If `true`, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to `false` or isn't specified, only jobs that include street level addresses will be returned by commute search.
*/
allowImpreciseAddresses?: boolean | null;
/**
* Required. The method of transportation to calculate the commute time for.
*/
commuteMethod?: string | null;
/**
* The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution.
*/
departureTime?: Schema$TimeOfDay;
/**
* Specifies the traffic density to use when calculating commute time.
*/
roadTraffic?: string | null;
/**
* Required. The latitude and longitude of the location to calculate the commute time from.
*/
startCoordinates?: Schema$LatLng;
/**
* Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.
*/
travelDuration?: string | null;
}
/**
* Commute details related to this job.
*/
export interface Schema$CommuteInfo {
/**
* Location used as the destination in the commute calculation.
*/
jobLocation?: Schema$Location;
/**
* The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job isn't reachable within the requested duration, but was returned as part of an expanded query.
*/
travelDuration?: string | null;
}
/**
* A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.
*/
export interface Schema$Company {
/**
* The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
*/
careerSiteUri?: string | null;
/**
* Output only. Derived details about the company.
*/
derivedInfo?: Schema$CompanyDerivedInfo;
/**
* Required. The display name of the company, for example, "Google LLC".
*/
displayName?: string | null;
/**
* Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.
*/
eeoText?: string | null;
/**
* Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
*/
externalId?: string | null;
/**
* The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.
*/
headquartersAddress?: string | null;
/**
* Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
*/
hiringAgency?: boolean | null;
/**
* A URI that hosts the employer's company logo.
*/
imageUri?: string | null;
/**
* A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword searches. Jobs with `string_values` under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.
*/
keywordSearchableJobCustomAttributes?: string[] | null;
/**
* Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/foo/tenants/bar/companies/baz".
*/
name?: string | null;
/**
* The employer's company size.
*/
size?: string | null;
/**
* Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.
*/
suspended?: boolean | null;
/**
* The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.
*/
websiteUri?: string | null;
}
/**
* Derived details about the company.
*/
export interface Schema$CompanyDerivedInfo {
/**
* A structured headquarters location of the company, resolved from Company.headquarters_address if provided.
*/
headquartersLocation?: Schema$Location;
}
/**
* A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.
*/
export interface Schema$CompensationEntry {
/**
* Compensation amount.
*/
amount?: Schema$Money;
/**
* Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.
*/
description?: string | null;
/**
* Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1
*/
expectedUnitsPerYear?: number | null;
/**
* Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.
*/
type?: string | null;
/**
* Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
*/
unit?: string | null;
}
/**
* Filter on job compensation type and amount.
*/
export interface Schema$CompensationFilter {
/**
* If set to true, jobs with unspecified compensation range fields are included.
*/
includeJobsWithUnspecifiedCompensationRange?: boolean | null;
/**
* Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Required. Type of filter.
*/
type?: string | null;
/**
* Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.
*/
units?: string[] | null;
}
/**
* Job compensation details.
*/
export interface Schema$CompensationInfo {
/**
* Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.
*/
annualizedBaseCompensationRange?: Schema$CompensationRange;
/**
* Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.
*/
annualizedTotalCompensationRange?: Schema$CompensationRange;
/**
* Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job.
*/
entries?: Schema$CompensationEntry[];
}
/**
* Compensation range.
*/
export interface Schema$CompensationRange {
/**
* The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation.
*/
maxCompensation?: Schema$Money;
/**
* The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation.
*/
minCompensation?: Schema$Money;
}
/**
* Response of auto-complete query.
*/
export interface Schema$CompleteQueryResponse {
/**
* Results of the matching job/company candidates.
*/
completionResults?: Schema$CompletionResult[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
}
/**
* Resource that represents completion results.
*/
export interface Schema$CompletionResult {
/**
* The URI of the company image for COMPANY_NAME.
*/
imageUri?: string | null;
/**
* The suggestion for the query.
*/
suggestion?: string | null;
/**
* The completion topic.
*/
type?: string | null;
}
/**
* Custom attribute values that are either filterable or non-filterable.
*/
export interface Schema$CustomAttribute {
/**
* If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.
*/
filterable?: boolean | null;
/**
* If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false.
*/
keywordSearchable?: boolean | null;
/**
* Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.
*/
longValues?: string[] | null;
/**
* Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed.
*/
stringValues?: string[] | null;
}
/**
* Custom ranking information for SearchJobsRequest.
*/
export interface Schema$CustomRankingInfo {
/**
* Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position. An error is thrown if not specified.
*/
importanceLevel?: string | null;
/**
* Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length. The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)
*/
rankingExpression?: string | null;
}
/**
* Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.
*/
export interface Schema$DeviceInfo {
/**
* Type of the device.
*/
deviceType?: string | null;
/**
* A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.
*/
id?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {
}
/**
* The histogram request.
*/
export interface Schema$HistogramQuery {
/**
* An expression specifies a histogram request against matching jobs for searches. See SearchJobsRequest.histogram_queries for details about syntax.
*/
histogramQuery?: string | null;
}
/**
* Histogram result that matches HistogramQuery specified in searches.
*/
export interface Schema$HistogramQueryResult {
/**
* A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value. The key format is: * (for string histogram) string values stored in the field. * (for named numeric bucket) name specified in `bucket()` function, like for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`. * (for anonymous numeric bucket) range formatted as `-`, for example, `0-1000`, `MIN-0`, and `0-MAX`.
*/
histogram?: {
[key: string]: string;
} | null;
/**
* Requested histogram expression.
*/
histogramQuery?: string | null;
}
/**
* A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.
*/
export interface Schema$Job {
/**
* Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500.
*/
addresses?: string[] | null;
/**
* Job application information.
*/
applicationInfo?: Schema$ApplicationInfo;
/**
* Required. The resource name of the company listing the job. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}". For example, "projects/foo/tenants/bar/companies/baz".
*/
company?: string | null;
/**
* Output only. Display name of the company listing the job.
*/
companyDisplayName?: string | null;
/**
* Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee.
*/
compensationInfo?: Schema$CompensationInfo;
/**
* A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.
*/
customAttributes?: {
[key: string]: Schema$CustomAttribute;
} | null;
/**
* The desired education degrees for the job, such as Bachelors, Masters.
*/
degreeTypes?: string[] | null;
/**
* The department or functional area within the company with the open position. The maximum number of allowed characters is 255.
*/
department?: string | null;
/**
* Output only. Derived details about the job posting.
*/
derivedInfo?: Schema$JobDerivedInfo;
/**
* Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000.
*/
description?: string | null;
/**
* The employment type(s) of a job, for example, full time or part time.
*/
employmentTypes?: string[] | null;
/**
* A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.
*/
incentives?: string | null;
/**
* The benefits included with the job.
*/
jobBenefits?: string[] | null;
/**
* The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
*/
jobEndTime?: string | null;
/**
* The experience level associated with the job, such as "Entry Level".
*/
jobLevel?: string | null;
/**
* The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
*/
jobStartTime?: string | null;
/**
* The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" \}. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.
*/
languageCode?: string | null;
/**
* Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
*/
name?: string | null;
/**
* Output only. The timestamp when this job posting was created.
*/
postingCreateTime?: string | null;
/**
* Strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.
*/
postingExpireTime?: string | null;
/**
* The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.
*/
postingPublishTime?: string | null;
/**
* The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.
*/
postingRegion?: string | null;
/**
* Output only. The timestamp when this job posting was last updated.
*/
postingUpdateTime?: string | null;
/**
* Options for job processing.
*/
processingOptions?: Schema$ProcessingOptions;
/**
* A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue \>0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0.
*/
promotionValue?: number | null;
/**
* A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.
*/
qualifications?: string | null;
/**
* Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id. The maximum number of allowed characters is 255.
*/
requisitionId?: string | null;
/**
* A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.
*/
responsibilities?: string | null;
/**
* Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
*/
title?: string | null;
/**
* Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.
*/
visibility?: string | null;
}
/**
* Derived details about the job posting.
*/
export interface Schema$JobDerivedInfo {
/**
* Job categories derived from Job.title and Job.description.
*/
jobCategories?: string[] | null;
/**
* Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.
*/
locations?: Schema$Location[];
}
/**
* An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
*/
export interface Schema$JobEvent {
/**
* Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}", for example, "projects/foo/tenants/bar/jobs/baz".
*/
jobs?: string[] | null;
/**
* Required. The type of the event (see JobEventType).
*/
type?: string | null;
}
/**
* The query required to perform a search query.
*/
export interface Schema$JobQuery {
/**
* Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored. Currently we don't support sorting by commute time.
*/
commuteFilter?: Schema$CommuteFilter;
/**
* This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}". For example, "projects/foo/tenants/bar/companies/baz". At most 20 company filters are allowed.
*/
companies?: string[] | null;
/**
* This filter specifies the exact company Company.display_name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed.
*/
companyDisplayNames?: string[] | null;
/**
* This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation \> $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.
*/
compensationFilter?: Schema$CompensationFilter;
/**
* This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `\>`, and `\>=` where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Supported functions are `LOWER([field_name])` to perform a case insensitive match and `EMPTY([field_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years \> 10`
*/
customAttributeFilter?: string | null;
/**
* This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed.
*/
disableSpellCheck?: boolean | null;
/**
* The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value isn't specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.
*/
employmentTypes?: string[] | null;
/**
* This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed.
*/
excludedJobs?: string[] | null;
/**
* The category filter specifies the categories of jobs to search against. See JobCategory for more information. If a value isn't specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.
*/
jobCategories?: string[] | null;
/**
* This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.
*/
languageCodes?: string[] | null;
/**
* The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.
*/
locationFilters?: Schema$LocationFilter[];
/**
* Jobs published within a range specified by this filter are searched against.
*/
publishTimeRange?: Schema$TimestampRange;
/**
* The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255.
*/
query?: string | null;
/**
* The language code of query. For example, "en-US". This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
*/
queryLanguageCode?: string | null;
}
/**
* Mutation result of a job from a batch operation.
*/
export interface Schema$JobResult {
/**
* Here Job only contains basic information including name, company, language_code and requisition_id, use getJob method to retrieve detailed information of the created/updated job.
*/
job?: Schema$Job;
/**
* The status of the job processed. This field is populated if the processing of the job fails.
*/
status?: Schema$Status;
}
/**
* An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
*/
export interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number | null;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number | null;
}
/**
* The List companies response object.
*/
export interface Schema$ListCompaniesResponse {
/**
* Companies for the current client.
*/
companies?: Schema$Company[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* List jobs response.
*/
export interface Schema$ListJobsResponse {
/**
* The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.
*/
jobs?: Schema$Job[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* The List tenants response object.
*/
export interface Schema$ListTenantsResponse {
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* Tenants for the current client.
*/
tenants?: Schema$Tenant[];
}
/**
* A resource that represents a location with full geographic information.
*/
export interface Schema$Location {
/**
* An object representing a latitude/longitude pair.
*/
latLng?: Schema$LatLng;
/**
* The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY.
*/
locationType?: string | null;
/**
* Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.
*/
postalAddress?: Schema$PostalAddress;
/**
* Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.
*/
radiusMiles?: number | null;
}
/**
* Geographic region of the search.
*/
export interface Schema$LocationFilter {
/**
* The address name, such as "Mountain View" or "Bay Area".
*/
address?: string | null;
/**
* The distance_in_miles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger.
*/
distanceInMiles?: number | null;
/**
* The latitude and longitude of the geographic center to search from. This field is ignored if `address` is provided.
*/
latLng?: Schema$LatLng;
/**
* CLDR region code of the country/region. This field may be used in two ways: 1) If telecommute preference is not set, this field is used address ambiguity of the user-input address. For example, "Liverpool" may refer to "Liverpool, NY, US" or "Liverpool, UK". This region code biases the address resolution toward a specific country or territory. If this field is not set, address resolution is biased toward the United States by default. 2) If telecommute preference is set to TELECOMMUTE_ALLOWED, the telecommute location filter will be limited to the region specified in this field. If this field is not set, the telecommute job locations will not be See https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
*/
regionCode?: string | null;
/**
* Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. This field is only used for job search requests.
*/
telecommutePreference?: string | null;
}
/**
* Job entry with metadata inside SearchJobsResponse.
*/
export interface Schema$MatchingJob {
/**
* Commute information which is generated based on specified CommuteFilter.
*/
commuteInfo?: Schema$CommuteInfo;
/**
* Job resource that matches the specified SearchJobsRequest.
*/
job?: Schema$Job;
/**
* A summary of the job with core information that's displayed on the search results listing page.
*/
jobSummary?: string | null;
/**
* Contains snippets of text from the Job.title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.
*/
jobTitleSnippet?: string | null;
/**
* Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.
*/
searchTextSnippet?: string | null;
}
/**
* Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2
*/
export interface Schema$MendelDebugInput {
/**
* When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details.
*/
namespacedDebugInput?: {
[key: string]: Schema$NamespacedDebugInput;
} | null;
}
/**
* Represents an amount of money with its currency type.
*/
export interface Schema$Money {
/**
* The three-letter currency code defined in ISO 4217.
*/
currencyCode?: string | null;
/**
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number | null;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string | null;
}
/**
* Next ID: 15
*/
export interface Schema$NamespacedDebugInput {
/**
* Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions.
*/
absolutelyForcedExpNames?: string[] | null;
/**
* Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions.
*/
absolutelyForcedExps?: number[] | null;
/**
* Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions.
*/
absolutelyForcedExpTags?: string[] | null;
/**
* Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true.
*/
conditionallyForcedExpNames?: string[] | null;
/**
* Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true.
*/
conditionallyForcedExps?: number[] | null;
/**
* Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true.
*/
conditionallyForcedExpTags?: string[] | null;
/**
* If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments.
*/
disableAutomaticEnrollmentSelection?: boolean | null;
/**
* Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.
*/
disableExpNames?: string[] | null;
/**
* Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.
*/
disableExps?: number[] | null;
/**
* Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together.
*/
disableExpTags?: string[] | null;
/**
* If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments.
*/
disableManualEnrollmentSelection?: boolean | null;
/**
* If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem.
*/
disableOrganicSelection?: boolean | null;
/**
* Flags to force in a particular experiment state. Map from flag name to flag value.
*/
forcedFlags?: {
[key: string]: string;
} | null;
/**
* Rollouts to force in a particular experiment state. Map from rollout name to rollout value.
*/
forcedRollouts?: {
[key: string]: boolean;
} | null;
}
/**
* 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;
}
/**
* Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
*/
export interface Schema$PostalAddress {
/**
* Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
*/
addressLines?: string[] | null;
/**
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
*/
administrativeArea?: string | null;
/**
* Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
*/
languageCode?: string | null;
/**
* Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
*/
locality?: string | null;
/**
* Optional. The name of the organization at the address.
*/
organization?: string | null;
/**
* Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
*/
postalCode?: string | null;
/**
* Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
*/
recipients?: string[] | null;
/**
* Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
*/
regionCode?: string | null;
/**
* The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
*/
revision?: number | null;
/**
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
*/
sortingCode?: string | null;
/**
* Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
*/
sublocality?: string | null;
}
/**
* Options for job processing.
*/
export interface Schema$ProcessingOptions {
/**
* If set to `true`, the service does not attempt to resolve a more precise address for the job.
*/
disableStreetAddressResolution?: boolean | null;
/**
* Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation isn't disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
*/
htmlSanitization?: string | null;
}
/**
* Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.
*/
export interface Schema$RequestMetadata {
/**
* Only set when any of domain, session_id and user_id isn't available for some reason. It is highly recommended not to set this field and provide accurate domain, session_id and user_id for the best service experience.
*/
allowMissingIds?: boolean | null;
/**
* The type of device used by the job seeker at the time of the call to the service.
*/
deviceInfo?: Schema$DeviceInfo;
/**
* Required if allow_missing_ids is unset or `false`. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client *Foo, Inc.*, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique domain. The maximum number of allowed characters is 255.
*/
domain?: string | null;
/**
* Required if allow_missing_ids is unset or `false`. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique session ID. The maximum number of allowed characters is 255.
*/
sessionId?: string | null;
/**
* Required if allow_missing_ids is unset or `false`. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique user ID. The maximum number of allowed characters is 255.
*/
userId?: string | null;
}
/**
* Additional information returned to client, such as debugging information.
*/
export interface Schema$ResponseMetadata {
/**
* A unique id associated with this call. This id is logged for tracking purposes.
*/
requestId?: string | null;
}
/**
* The Request body of the `SearchJobs` call.
*/
export interface Schema$SearchJobsRequest {
/**
* Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).
*/
customRankingInfo?: Schema$CustomRankingInfo;
/**
* Controls whether to disable exact keyword match on Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query "program manager," a result is returned even if the job posting has the title "software developer," which doesn't fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Use Company.keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false.
*/
disableKeywordMatch?: boolean | null;
/**
* Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified.
*/
diversificationLevel?: string | null;
/**
* Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false.
*/
enableBroadening?: boolean | null;
/**
* An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name. * employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level, for example, "Entry Level". * country: histogram by the country code of jobs, for example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code, for example, "en", "fr". * category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute["some-string-custom-attribute"])` * `count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])`
*/
histogramQueries?: Schema$HistogramQuery[];
/**
* Query used to search against jobs, such as keyword, location filters, etc.
*/
jobQuery?: Schema$JobQuery;
/**
* The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_SMALL if no value is specified.
*/
jobView?: string | null;
/**
* A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.
*/
maxPageSize?: number | null;
/**
* An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).
*/
offset?: number | null;
/**
* The criteria determining how search results are sorted. Default is `"relevance desc"`. Supported options are: * `"relevance desc"`: By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * `"posting_publish_time desc"`: By Job.posting_publish_time descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_base_compensation desc"`: By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation"`: By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation desc"`: By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"custom_ranking desc"`: By the relevance score adjusted to the SearchJobsRequest.CustomRankingInfo.ranking_expression with weight factor assigned by SearchJobsRequest.CustomRankingInfo.importance_level in descending order. * Location sorting: Use the special syntax to order jobs by distance: `"distance_from('Hawaii')"`: Order by distance from Hawaii. `"distance_from(19.89, 155.5)"`: Order by distance from a coordinate. `"distance_from('Hawaii'), distance_from('Puerto Rico')"`: Order by multiple locations. See details below. `"distance_from('Hawaii'), distance_from(19.89, 155.5)"`: Order by multiple locations. See details below. The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level.
*/
orderBy?: string | null;
/**
* The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.
*/
pageToken?: string | null;
/**
* Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as `user_id`) are provided by users, and must be unique and consistent.
*/
requestMetadata?: Schema$RequestMetadata;
/**
* Mode of a search. Defaults to SearchMode.JOB_SEARCH.
*/
searchMode?: string | null;
}
/**
* Response for SearchJob method.
*/
export interface Schema$SearchJobsResponse {
/**
* If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.
*/
broadenedQueryJobsCount?: number | null;
/**
* The histogram results that match with specified SearchJobsRequest.histogram_queries.
*/
histogramQueryResults?: Schema$HistogramQueryResult[];
/**
* The location filters that the service applied to the specified query. If any filters are lat-lng based, the Location.location_type is Location.LocationType.LOCATION_TYPE_UNSPECIFIED.
*/
locationFilters?: Schema$Location[];
/**
* The Job entities that match the specified SearchJobsRequest.
*/
matchingJobs?: Schema$MatchingJob[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* The token that specifies the starting position of the next page of results. This field is empty if there are no more results.
*/
nextPageToken?: string | null;
/**
* The spell checking result, and correction.
*/
spellCorrection?: Schema$SpellingCorrection;
/**
* Number of jobs that match the specified query. Note: This size is precise only if the total is less than 100,000.
*/
totalSize?: number | null;
}
/**
* Spell check result.
*/
export interface Schema$SpellingCorrection {
/**
* Indicates if the query was corrected by the spell checker.
*/
corrected?: boolean | null;
/**
* Corrected output with html tags to highlight the corrected words. Corrected words are called out with the "*...*" html tags. For example, the user input query is "software enginear", where the second word, "enginear," is incorrect. It should be "engineer". When spelling correction is enabled, this value is "software *engineer*".
*/
correctedHtml?: string | null;
/**
* Correction output consisting of the corrected keyword string.
*/
correctedText?: string | null;
}
/**
* 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 Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups.
*/
export interface Schema$Tenant {
/**
* Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.
*/
externalId?: string | null;
/**
* Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
*/
name?: string | null;
}
/**
* Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
*/
export interface Schema$TimeOfDay {
/**
* Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
*/
hours?: number | null;
/**
* Minutes of hour of day. Must be from 0 to 59.
*/
minutes?: number | null;
/**
* Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
*/
nanos?: number | null;
/**
* Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
*/
seconds?: number | null;
}
/**
* Message representing a period of time between two timestamps.
*/
export interface Schema$TimestampRange {
/**
* End of the period (exclusive).
*/
endTime?: string | null;
/**
* Begin of the period (inclusive).
*/
startTime?: string | null;
}
export class Resource$Projects {
context: APIRequestContext;
operations: Resource$Projects$Operations;
tenants: Resource$Projects$Tenants;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.operations.get({
* // The name of the operation resource.
* name: 'projects/my-project/operations/my-operation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Projects$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Projects$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Operations$Get extends StandardParameters {
/**
* The name of the operation resource.
*/
name?: string;
}
export class Resource$Projects$Tenants {
context: APIRequestContext;
clientEvents: Resource$Projects$Tenants$Clientevents;
companies: Resource$Projects$Tenants$Companies;
jobs: Resource$Projects$Tenants$Jobs;
constructor(context: APIRequestContext);
/**
* Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.completeQuery({
* // If provided, restricts completion to specified company. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/foo/tenants/bar/companies/baz".
* company: 'placeholder-value',
* // The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of allowed characters is 255.
* languageCodes: 'placeholder-value',
* // Required. Completion result count. The maximum allowed page size is 10.
* pageSize: 'placeholder-value',
* // Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
* query: 'placeholder-value',
* // The scope of the completion. The defaults is CompletionScope.PUBLIC.
* scope: 'placeholder-value',
* // Required. Resource name of tenant the completion is performed within. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
* tenant: 'projects/my-project/tenants/my-tenant',
* // The completion topic. The default is CompletionType.COMBINED.
* type: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "completionResults": [],
* // "metadata": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
completeQuery(params: Params$Resource$Projects$Tenants$Completequery, options: StreamMethodOptions): GaxiosPromise<Readable>;
completeQuery(params?: Params$Resource$Projects$Tenants$Completequery, options?: MethodOptions): GaxiosPromise<Schema$CompleteQueryResponse>;
completeQuery(params: Params$Resource$Projects$Tenants$Completequery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
completeQuery(params: Params$Resource$Projects$Tenants$Completequery, options: MethodOptions | BodyResponseCallback<Schema$CompleteQueryResponse>, callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
completeQuery(params: Params$Resource$Projects$Tenants$Completequery, callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
completeQuery(callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
/**
* Creates a new tenant entity.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.create({
* // Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id\}", for example, "projects/foo".
* parent: 'projects/my-project',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "externalId": "my_externalId",
* // "name": "my_name"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "externalId": "my_externalId",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Tenants$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Tenants$Create, options?: MethodOptions): GaxiosPromise<Schema$Tenant>;
create(params: Params$Resource$Projects$Tenants$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Tenants$Create, options: MethodOptions | BodyResponseCallback<Schema$Tenant>, callback: BodyResponseCallback<Schema$Tenant>): void;
create(params: Params$Resource$Projects$Tenants$Create, callback: BodyResponseCallback<Schema$Tenant>): void;
create(callback: BodyResponseCallback<Schema$Tenant>): void;
/**
* Deletes specified tenant.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.delete({
* // Required. The resource name of the tenant to be deleted. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
* name: 'projects/my-project/tenants/my-tenant',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Tenants$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Tenants$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Tenants$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Tenants$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Tenants$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Retrieves specified tenant.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.get({
* // Required. The resource name of the tenant to be retrieved. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
* name: 'projects/my-project/tenants/my-tenant',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "externalId": "my_externalId",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Tenants$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Tenants$Get, options?: MethodOptions): GaxiosPromise<Schema$Tenant>;
get(params: Params$Resource$Projects$Tenants$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Tenants$Get, options: MethodOptions | BodyResponseCallback<Schema$Tenant>, callback: BodyResponseCallback<Schema$Tenant>): void;
get(params: Params$Resource$Projects$Tenants$Get, callback: BodyResponseCallback<Schema$Tenant>): void;
get(callback: BodyResponseCallback<Schema$Tenant>): void;
/**
* Lists all tenants associated with the project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.list({
* // The maximum number of tenants to be returned, at most 100. Default is 100 if a non-positive number is provided.
* pageSize: 'placeholder-value',
* // The starting indicator from which to return results.
* pageToken: 'placeholder-value',
* // Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id\}", for example, "projects/foo".
* parent: 'projects/my-project',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "metadata": {},
* // "nextPageToken": "my_nextPageToken",
* // "tenants": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Tenants$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Tenants$List, options?: MethodOptions): GaxiosPromise<Schema$ListTenantsResponse>;
list(params: Params$Resource$Projects$Tenants$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Tenants$List, options: MethodOptions | BodyResponseCallback<Schema$ListTenantsResponse>, callback: BodyResponseCallback<Schema$ListTenantsResponse>): void;
list(params: Params$Resource$Projects$Tenants$List, callback: BodyResponseCallback<Schema$ListTenantsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTenantsResponse>): void;
/**
* Updates specified tenant.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.patch({
* // Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
* name: 'projects/my-project/tenants/my-tenant',
* // Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in tenant are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "externalId": "my_externalId",
* // "name": "my_name"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "externalId": "my_externalId",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Tenants$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Tenants$Patch, options?: MethodOptions): GaxiosPromise<Schema$Tenant>;
patch(params: Params$Resource$Projects$Tenants$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Tenants$Patch, options: MethodOptions | BodyResponseCallback<Schema$Tenant>, callback: BodyResponseCallback<Schema$Tenant>): void;
patch(params: Params$Resource$Projects$Tenants$Patch, callback: BodyResponseCallback<Schema$Tenant>): void;
patch(callback: BodyResponseCallback<Schema$Tenant>): void;
}
export interface Params$Resource$Projects$Tenants$Completequery extends StandardParameters {
/**
* If provided, restricts completion to specified company. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/foo/tenants/bar/companies/baz".
*/
company?: string;
/**
* The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of allowed characters is 255.
*/
languageCodes?: string[];
/**
* Required. Completion result count. The maximum allowed page size is 10.
*/
pageSize?: number;
/**
* Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
*/
query?: string;
/**
* The scope of the completion. The defaults is CompletionScope.PUBLIC.
*/
scope?: string;
/**
* Required. Resource name of tenant the completion is performed within. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
*/
tenant?: string;
/**
* The completion topic. The default is CompletionType.COMBINED.
*/
type?: string;
}
export interface Params$Resource$Projects$Tenants$Create extends StandardParameters {
/**
* Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id\}", for example, "projects/foo".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Tenant;
}
export interface Params$Resource$Projects$Tenants$Delete extends StandardParameters {
/**
* Required. The resource name of the tenant to be deleted. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
*/
name?: string;
}
export interface Params$Resource$Projects$Tenants$Get extends StandardParameters {
/**
* Required. The resource name of the tenant to be retrieved. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
*/
name?: string;
}
export interface Params$Resource$Projects$Tenants$List extends StandardParameters {
/**
* The maximum number of tenants to be returned, at most 100. Default is 100 if a non-positive number is provided.
*/
pageSize?: number;
/**
* The starting indicator from which to return results.
*/
pageToken?: string;
/**
* Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id\}", for example, "projects/foo".
*/
parent?: string;
}
export interface Params$Resource$Projects$Tenants$Patch extends StandardParameters {
/**
* Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
*/
name?: string;
/**
* Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in tenant are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Tenant;
}
export class Resource$Projects$Tenants$Clientevents {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in [self service tools](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.clientEvents.create({
* // Required. Resource name of the tenant under which the event is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "createTime": "my_createTime",
* // "eventId": "my_eventId",
* // "eventNotes": "my_eventNotes",
* // "jobEvent": {},
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "eventId": "my_eventId",
* // "eventNotes": "my_eventNotes",
* // "jobEvent": {},
* // "requestId": "my_requestId"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Tenants$Clientevents$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Tenants$Clientevents$Create, options?: MethodOptions): GaxiosPromise<Schema$ClientEvent>;
create(params: Params$Resource$Projects$Tenants$Clientevents$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Tenants$Clientevents$Create, options: MethodOptions | BodyResponseCallback<Schema$ClientEvent>, callback: BodyResponseCallback<Schema$ClientEvent>): void;
create(params: Params$Resource$Projects$Tenants$Clientevents$Create, callback: BodyResponseCallback<Schema$ClientEvent>): void;
create(callback: BodyResponseCallback<Schema$ClientEvent>): void;
}
export interface Params$Resource$Projects$Tenants$Clientevents$Create extends StandardParameters {
/**
* Required. Resource name of the tenant under which the event is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ClientEvent;
}
export class Resource$Projects$Tenants$Companies {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new company entity.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.companies.create({
* // Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "careerSiteUri": "my_careerSiteUri",
* // "derivedInfo": {},
* // "displayName": "my_displayName",
* // "eeoText": "my_eeoText",
* // "externalId": "my_externalId",
* // "headquartersAddress": "my_headquartersAddress",
* // "hiringAgency": false,
* // "imageUri": "my_imageUri",
* // "keywordSearchableJobCustomAttributes": [],
* // "name": "my_name",
* // "size": "my_size",
* // "suspended": false,
* // "websiteUri": "my_websiteUri"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "careerSiteUri": "my_careerSiteUri",
* // "derivedInfo": {},
* // "displayName": "my_displayName",
* // "eeoText": "my_eeoText",
* // "externalId": "my_externalId",
* // "headquartersAddress": "my_headquartersAddress",
* // "hiringAgency": false,
* // "imageUri": "my_imageUri",
* // "keywordSearchableJobCustomAttributes": [],
* // "name": "my_name",
* // "size": "my_size",
* // "suspended": false,
* // "websiteUri": "my_websiteUri"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Tenants$Companies$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Tenants$Companies$Create, options?: MethodOptions): GaxiosPromise<Schema$Company>;
create(params: Params$Resource$Projects$Tenants$Companies$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Tenants$Companies$Create, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
create(params: Params$Resource$Projects$Tenants$Companies$Create, callback: BodyResponseCallback<Schema$Company>): void;
create(callback: BodyResponseCallback<Schema$Company>): void;
/**
* Deletes specified company. Prerequisite: The company has no jobs associated with it.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.companies.delete({
* // Required. The resource name of the company to be deleted. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/foo/tenants/bar/companies/baz".
* name: 'projects/my-project/tenants/my-tenant/companies/my-companie',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Tenants$Companies$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Tenants$Companies$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Tenants$Companies$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Tenants$Companies$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Tenants$Companies$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Retrieves specified company.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.companies.get({
* // Required. The resource name of the company to be retrieved. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/api-test-project/tenants/foo/companies/bar".
* name: 'projects/my-project/tenants/my-tenant/companies/my-companie',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "careerSiteUri": "my_careerSiteUri",
* // "derivedInfo": {},
* // "displayName": "my_displayName",
* // "eeoText": "my_eeoText",
* // "externalId": "my_externalId",
* // "headquartersAddress": "my_headquartersAddress",
* // "hiringAgency": false,
* // "imageUri": "my_imageUri",
* // "keywordSearchableJobCustomAttributes": [],
* // "name": "my_name",
* // "size": "my_size",
* // "suspended": false,
* // "websiteUri": "my_websiteUri"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Tenants$Companies$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Tenants$Companies$Get, options?: MethodOptions): GaxiosPromise<Schema$Company>;
get(params: Params$Resource$Projects$Tenants$Companies$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Tenants$Companies$Get, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
get(params: Params$Resource$Projects$Tenants$Companies$Get, callback: BodyResponseCallback<Schema$Company>): void;
get(callback: BodyResponseCallback<Schema$Company>): void;
/**
* Lists all companies associated with the project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.companies.list({
* // The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.
* pageSize: 'placeholder-value',
* // The starting indicator from which to return results.
* pageToken: 'placeholder-value',
* // Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
* // Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.
* requireOpenJobs: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "companies": [],
* // "metadata": {},
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Tenants$Companies$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Tenants$Companies$List, options?: MethodOptions): GaxiosPromise<Schema$ListCompaniesResponse>;
list(params: Params$Resource$Projects$Tenants$Companies$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Tenants$Companies$List, options: MethodOptions | BodyResponseCallback<Schema$ListCompaniesResponse>, callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
list(params: Params$Resource$Projects$Tenants$Companies$List, callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
/**
* Updates specified company.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.companies.patch({
* // Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/foo/tenants/bar/companies/baz".
* name: 'projects/my-project/tenants/my-tenant/companies/my-companie',
* // Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "careerSiteUri": "my_careerSiteUri",
* // "derivedInfo": {},
* // "displayName": "my_displayName",
* // "eeoText": "my_eeoText",
* // "externalId": "my_externalId",
* // "headquartersAddress": "my_headquartersAddress",
* // "hiringAgency": false,
* // "imageUri": "my_imageUri",
* // "keywordSearchableJobCustomAttributes": [],
* // "name": "my_name",
* // "size": "my_size",
* // "suspended": false,
* // "websiteUri": "my_websiteUri"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "careerSiteUri": "my_careerSiteUri",
* // "derivedInfo": {},
* // "displayName": "my_displayName",
* // "eeoText": "my_eeoText",
* // "externalId": "my_externalId",
* // "headquartersAddress": "my_headquartersAddress",
* // "hiringAgency": false,
* // "imageUri": "my_imageUri",
* // "keywordSearchableJobCustomAttributes": [],
* // "name": "my_name",
* // "size": "my_size",
* // "suspended": false,
* // "websiteUri": "my_websiteUri"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Tenants$Companies$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Tenants$Companies$Patch, options?: MethodOptions): GaxiosPromise<Schema$Company>;
patch(params: Params$Resource$Projects$Tenants$Companies$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Tenants$Companies$Patch, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
patch(params: Params$Resource$Projects$Tenants$Companies$Patch, callback: BodyResponseCallback<Schema$Company>): void;
patch(callback: BodyResponseCallback<Schema$Company>): void;
}
export interface Params$Resource$Projects$Tenants$Companies$Create extends StandardParameters {
/**
* Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Company;
}
export interface Params$Resource$Projects$Tenants$Companies$Delete extends StandardParameters {
/**
* Required. The resource name of the company to be deleted. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/foo/tenants/bar/companies/baz".
*/
name?: string;
}
export interface Params$Resource$Projects$Tenants$Companies$Get extends StandardParameters {
/**
* Required. The resource name of the company to be retrieved. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/api-test-project/tenants/foo/companies/bar".
*/
name?: string;
}
export interface Params$Resource$Projects$Tenants$Companies$List extends StandardParameters {
/**
* The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.
*/
pageSize?: number;
/**
* The starting indicator from which to return results.
*/
pageToken?: string;
/**
* Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id\}/tenants/{tenant_id\}", for example, "projects/foo/tenants/bar".
*/
parent?: string;
/**
* Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.
*/
requireOpenJobs?: boolean;
}
export interface Params$Resource$Projects$Tenants$Companies$Patch extends StandardParameters {
/**
* Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id\}/tenants/{tenant_id\}/companies/{company_id\}", for example, "projects/foo/tenants/bar/companies/baz".
*/
name?: string;
/**
* Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Company;
}
export class Resource$Projects$Tenants$Jobs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Begins executing a batch create jobs operation.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.batchCreate({
* // Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "jobs": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
batchCreate(params: Params$Resource$Projects$Tenants$Jobs$Batchcreate, options: StreamMethodOptions): GaxiosPromise<Readable>;
batchCreate(params?: Params$Resource$Projects$Tenants$Jobs$Batchcreate, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
batchCreate(params: Params$Resource$Projects$Tenants$Jobs$Batchcreate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
batchCreate(params: Params$Resource$Projects$Tenants$Jobs$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
batchCreate(params: Params$Resource$Projects$Tenants$Jobs$Batchcreate, callback: BodyResponseCallback<Schema$Operation>): void;
batchCreate(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Begins executing a batch delete jobs operation.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.batchDelete({
* // Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar". The parent of all of the jobs specified in `names` must match this field.
* parent: 'projects/my-project/tenants/my-tenant',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "names": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
batchDelete(params: Params$Resource$Projects$Tenants$Jobs$Batchdelete, options: StreamMethodOptions): GaxiosPromise<Readable>;
batchDelete(params?: Params$Resource$Projects$Tenants$Jobs$Batchdelete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
batchDelete(params: Params$Resource$Projects$Tenants$Jobs$Batchdelete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
batchDelete(params: Params$Resource$Projects$Tenants$Jobs$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
batchDelete(params: Params$Resource$Projects$Tenants$Jobs$Batchdelete, callback: BodyResponseCallback<Schema$Operation>): void;
batchDelete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Begins executing a batch update jobs operation.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.batchUpdate({
* // Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "jobs": [],
* // "updateMask": "my_updateMask"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
batchUpdate(params: Params$Resource$Projects$Tenants$Jobs$Batchupdate, options: StreamMethodOptions): GaxiosPromise<Readable>;
batchUpdate(params?: Params$Resource$Projects$Tenants$Jobs$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
batchUpdate(params: Params$Resource$Projects$Tenants$Jobs$Batchupdate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
batchUpdate(params: Params$Resource$Projects$Tenants$Jobs$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
batchUpdate(params: Params$Resource$Projects$Tenants$Jobs$Batchupdate, callback: BodyResponseCallback<Schema$Operation>): void;
batchUpdate(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.create({
* // Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "addresses": [],
* // "applicationInfo": {},
* // "company": "my_company",
* // "companyDisplayName": "my_companyDisplayName",
* // "compensationInfo": {},
* // "customAttributes": {},
* // "degreeTypes": [],
* // "department": "my_department",
* // "derivedInfo": {},
* // "description": "my_description",
* // "employmentTypes": [],
* // "incentives": "my_incentives",
* // "jobBenefits": [],
* // "jobEndTime": "my_jobEndTime",
* // "jobLevel": "my_jobLevel",
* // "jobStartTime": "my_jobStartTime",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "postingCreateTime": "my_postingCreateTime",
* // "postingExpireTime": "my_postingExpireTime",
* // "postingPublishTime": "my_postingPublishTime",
* // "postingRegion": "my_postingRegion",
* // "postingUpdateTime": "my_postingUpdateTime",
* // "processingOptions": {},
* // "promotionValue": 0,
* // "qualifications": "my_qualifications",
* // "requisitionId": "my_requisitionId",
* // "responsibilities": "my_responsibilities",
* // "title": "my_title",
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "addresses": [],
* // "applicationInfo": {},
* // "company": "my_company",
* // "companyDisplayName": "my_companyDisplayName",
* // "compensationInfo": {},
* // "customAttributes": {},
* // "degreeTypes": [],
* // "department": "my_department",
* // "derivedInfo": {},
* // "description": "my_description",
* // "employmentTypes": [],
* // "incentives": "my_incentives",
* // "jobBenefits": [],
* // "jobEndTime": "my_jobEndTime",
* // "jobLevel": "my_jobLevel",
* // "jobStartTime": "my_jobStartTime",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "postingCreateTime": "my_postingCreateTime",
* // "postingExpireTime": "my_postingExpireTime",
* // "postingPublishTime": "my_postingPublishTime",
* // "postingRegion": "my_postingRegion",
* // "postingUpdateTime": "my_postingUpdateTime",
* // "processingOptions": {},
* // "promotionValue": 0,
* // "qualifications": "my_qualifications",
* // "requisitionId": "my_requisitionId",
* // "responsibilities": "my_responsibilities",
* // "title": "my_title",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Tenants$Jobs$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Tenants$Jobs$Create, options?: MethodOptions): GaxiosPromise<Schema$Job>;
create(params: Params$Resource$Projects$Tenants$Jobs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Tenants$Jobs$Create, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
create(params: Params$Resource$Projects$Tenants$Jobs$Create, callback: BodyResponseCallback<Schema$Job>): void;
create(callback: BodyResponseCallback<Schema$Job>): void;
/**
* Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.delete({
* // Required. The resource name of the job to be deleted. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz".
* name: 'projects/my-project/tenants/my-tenant/jobs/my-job',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Tenants$Jobs$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Tenants$Jobs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Tenants$Jobs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Tenants$Jobs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Tenants$Jobs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.get({
* // Required. The resource name of the job to retrieve. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz".
* name: 'projects/my-project/tenants/my-tenant/jobs/my-job',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "addresses": [],
* // "applicationInfo": {},
* // "company": "my_company",
* // "companyDisplayName": "my_companyDisplayName",
* // "compensationInfo": {},
* // "customAttributes": {},
* // "degreeTypes": [],
* // "department": "my_department",
* // "derivedInfo": {},
* // "description": "my_description",
* // "employmentTypes": [],
* // "incentives": "my_incentives",
* // "jobBenefits": [],
* // "jobEndTime": "my_jobEndTime",
* // "jobLevel": "my_jobLevel",
* // "jobStartTime": "my_jobStartTime",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "postingCreateTime": "my_postingCreateTime",
* // "postingExpireTime": "my_postingExpireTime",
* // "postingPublishTime": "my_postingPublishTime",
* // "postingRegion": "my_postingRegion",
* // "postingUpdateTime": "my_postingUpdateTime",
* // "processingOptions": {},
* // "promotionValue": 0,
* // "qualifications": "my_qualifications",
* // "requisitionId": "my_requisitionId",
* // "responsibilities": "my_responsibilities",
* // "title": "my_title",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Tenants$Jobs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Tenants$Jobs$Get, options?: MethodOptions): GaxiosPromise<Schema$Job>;
get(params: Params$Resource$Projects$Tenants$Jobs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Tenants$Jobs$Get, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
get(params: Params$Resource$Projects$Tenants$Jobs$Get, callback: BodyResponseCallback<Schema$Job>): void;
get(callback: BodyResponseCallback<Schema$Job>): void;
/**
* Lists jobs by filter.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.list({
* // Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` * `status` Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. Sample Query: * companyName = "projects/foo/tenants/bar/companies/baz" * companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1" * companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED"
* filter: 'placeholder-value',
* // The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.
* jobView: 'placeholder-value',
* // The maximum number of jobs to be returned per page of results. If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.
* pageSize: 'placeholder-value',
* // The starting point of a query result.
* pageToken: 'placeholder-value',
* // Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "jobs": [],
* // "metadata": {},
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Tenants$Jobs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Tenants$Jobs$List, options?: MethodOptions): GaxiosPromise<Schema$ListJobsResponse>;
list(params: Params$Resource$Projects$Tenants$Jobs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Tenants$Jobs$List, options: MethodOptions | BodyResponseCallback<Schema$ListJobsResponse>, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
list(params: Params$Resource$Projects$Tenants$Jobs$List, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
/**
* Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.patch({
* // Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
* name: 'projects/my-project/tenants/my-tenant/jobs/my-job',
* // Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "addresses": [],
* // "applicationInfo": {},
* // "company": "my_company",
* // "companyDisplayName": "my_companyDisplayName",
* // "compensationInfo": {},
* // "customAttributes": {},
* // "degreeTypes": [],
* // "department": "my_department",
* // "derivedInfo": {},
* // "description": "my_description",
* // "employmentTypes": [],
* // "incentives": "my_incentives",
* // "jobBenefits": [],
* // "jobEndTime": "my_jobEndTime",
* // "jobLevel": "my_jobLevel",
* // "jobStartTime": "my_jobStartTime",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "postingCreateTime": "my_postingCreateTime",
* // "postingExpireTime": "my_postingExpireTime",
* // "postingPublishTime": "my_postingPublishTime",
* // "postingRegion": "my_postingRegion",
* // "postingUpdateTime": "my_postingUpdateTime",
* // "processingOptions": {},
* // "promotionValue": 0,
* // "qualifications": "my_qualifications",
* // "requisitionId": "my_requisitionId",
* // "responsibilities": "my_responsibilities",
* // "title": "my_title",
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "addresses": [],
* // "applicationInfo": {},
* // "company": "my_company",
* // "companyDisplayName": "my_companyDisplayName",
* // "compensationInfo": {},
* // "customAttributes": {},
* // "degreeTypes": [],
* // "department": "my_department",
* // "derivedInfo": {},
* // "description": "my_description",
* // "employmentTypes": [],
* // "incentives": "my_incentives",
* // "jobBenefits": [],
* // "jobEndTime": "my_jobEndTime",
* // "jobLevel": "my_jobLevel",
* // "jobStartTime": "my_jobStartTime",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "postingCreateTime": "my_postingCreateTime",
* // "postingExpireTime": "my_postingExpireTime",
* // "postingPublishTime": "my_postingPublishTime",
* // "postingRegion": "my_postingRegion",
* // "postingUpdateTime": "my_postingUpdateTime",
* // "processingOptions": {},
* // "promotionValue": 0,
* // "qualifications": "my_qualifications",
* // "requisitionId": "my_requisitionId",
* // "responsibilities": "my_responsibilities",
* // "title": "my_title",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Tenants$Jobs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Tenants$Jobs$Patch, options?: MethodOptions): GaxiosPromise<Schema$Job>;
patch(params: Params$Resource$Projects$Tenants$Jobs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Tenants$Jobs$Patch, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
patch(params: Params$Resource$Projects$Tenants$Jobs$Patch, callback: BodyResponseCallback<Schema$Job>): void;
patch(callback: BodyResponseCallback<Schema$Job>): void;
/**
* Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.search({
* // Required. The resource name of the tenant to search within. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "customRankingInfo": {},
* // "disableKeywordMatch": false,
* // "diversificationLevel": "my_diversificationLevel",
* // "enableBroadening": false,
* // "histogramQueries": [],
* // "jobQuery": {},
* // "jobView": "my_jobView",
* // "maxPageSize": 0,
* // "offset": 0,
* // "orderBy": "my_orderBy",
* // "pageToken": "my_pageToken",
* // "requestMetadata": {},
* // "searchMode": "my_searchMode"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "broadenedQueryJobsCount": 0,
* // "histogramQueryResults": [],
* // "locationFilters": [],
* // "matchingJobs": [],
* // "metadata": {},
* // "nextPageToken": "my_nextPageToken",
* // "spellCorrection": {},
* // "totalSize": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
search(params: Params$Resource$Projects$Tenants$Jobs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
search(params?: Params$Resource$Projects$Tenants$Jobs$Search, options?: MethodOptions): GaxiosPromise<Schema$SearchJobsResponse>;
search(params: Params$Resource$Projects$Tenants$Jobs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
search(params: Params$Resource$Projects$Tenants$Jobs$Search, options: MethodOptions | BodyResponseCallback<Schema$SearchJobsResponse>, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
search(params: Params$Resource$Projects$Tenants$Jobs$Search, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
search(callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
/**
* Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), it has different algorithmic adjustments that are designed to specifically target passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/jobs.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/jobs',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await jobs.projects.tenants.jobs.searchForAlert({
* // Required. The resource name of the tenant to search within. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
* parent: 'projects/my-project/tenants/my-tenant',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "customRankingInfo": {},
* // "disableKeywordMatch": false,
* // "diversificationLevel": "my_diversificationLevel",
* // "enableBroadening": false,
* // "histogramQueries": [],
* // "jobQuery": {},
* // "jobView": "my_jobView",
* // "maxPageSize": 0,
* // "offset": 0,
* // "orderBy": "my_orderBy",
* // "pageToken": "my_pageToken",
* // "requestMetadata": {},
* // "searchMode": "my_searchMode"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "broadenedQueryJobsCount": 0,
* // "histogramQueryResults": [],
* // "locationFilters": [],
* // "matchingJobs": [],
* // "metadata": {},
* // "nextPageToken": "my_nextPageToken",
* // "spellCorrection": {},
* // "totalSize": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
searchForAlert(params: Params$Resource$Projects$Tenants$Jobs$Searchforalert, options: StreamMethodOptions): GaxiosPromise<Readable>;
searchForAlert(params?: Params$Resource$Projects$Tenants$Jobs$Searchforalert, options?: MethodOptions): GaxiosPromise<Schema$SearchJobsResponse>;
searchForAlert(params: Params$Resource$Projects$Tenants$Jobs$Searchforalert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
searchForAlert(params: Params$Resource$Projects$Tenants$Jobs$Searchforalert, options: MethodOptions | BodyResponseCallback<Schema$SearchJobsResponse>, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
searchForAlert(params: Params$Resource$Projects$Tenants$Jobs$Searchforalert, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
searchForAlert(callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
}
export interface Params$Resource$Projects$Tenants$Jobs$Batchcreate extends StandardParameters {
/**
* Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchCreateJobsRequest;
}
export interface Params$Resource$Projects$Tenants$Jobs$Batchdelete extends StandardParameters {
/**
* Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar". The parent of all of the jobs specified in `names` must match this field.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchDeleteJobsRequest;
}
export interface Params$Resource$Projects$Tenants$Jobs$Batchupdate extends StandardParameters {
/**
* Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchUpdateJobsRequest;
}
export interface Params$Resource$Projects$Tenants$Jobs$Create extends StandardParameters {
/**
* Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Job;
}
export interface Params$Resource$Projects$Tenants$Jobs$Delete extends StandardParameters {
/**
* Required. The resource name of the job to be deleted. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz".
*/
name?: string;
}
export interface Params$Resource$Projects$Tenants$Jobs$Get extends StandardParameters {
/**
* Required. The resource name of the job to retrieve. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz".
*/
name?: string;
}
export interface Params$Resource$Projects$Tenants$Jobs$List extends StandardParameters {
/**
* Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` * `status` Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. Sample Query: * companyName = "projects/foo/tenants/bar/companies/baz" * companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1" * companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED"
*/
filter?: string;
/**
* The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.
*/
jobView?: string;
/**
* The maximum number of jobs to be returned per page of results. If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.
*/
pageSize?: number;
/**
* The starting point of a query result.
*/
pageToken?: string;
/**
* Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
*/
parent?: string;
}
export interface Params$Resource$Projects$Tenants$Jobs$Patch extends StandardParameters {
/**
* Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
*/
name?: string;
/**
* Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Job;
}
export interface Params$Resource$Projects$Tenants$Jobs$Search extends StandardParameters {
/**
* Required. The resource name of the tenant to search within. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SearchJobsRequest;
}
export interface Params$Resource$Projects$Tenants$Jobs$Searchforalert extends StandardParameters {
/**
* Required. The resource name of the tenant to search within. The format is "projects/{project_id\}/tenants/{tenant_id\}". For example, "projects/foo/tenants/bar".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SearchJobsRequest;
}
export {};
}