v3p1beta1.d.ts
127 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
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace jobs_v3p1beta1 {
interface Options extends GlobalOptions {
version: 'v3p1beta1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud 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
* const {google} = require('googleapis');
* const jobs = google.jobs('v3p1beta1');
*
* @namespace jobs
* @type {Function}
* @version v3p1beta1
* @variation v3p1beta1
* @param {object=} options Options for Jobs
*/
class Jobs {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Application related details of a job posting.
*/
interface Schema$ApplicationInfo {
/**
* Optional but at least one of uris, emails or instruction must be
* specified. 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[];
/**
* Optional but at least one of uris, emails or instruction must be
* specified. 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;
/**
* Optional but at least one of uris, emails or instruction must be
* specified. 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[];
}
/**
* Input only. Batch delete jobs request.
*/
interface Schema$BatchDeleteJobsRequest {
/**
* Required. The filter string specifies the jobs to be deleted. Supported
* operator: =, AND The fields eligible for filtering are: * `companyName`
* (Required) * `requisitionId` (Required) Sample Query: companyName =
* "projects/api-test-project/companies/123" AND requisitionId =
* "req-1"
*/
filter?: string;
}
/**
* Represents count of jobs within one bucket.
*/
interface Schema$BucketizedCount {
/**
* Number of jobs whose numeric field value fall into `range`.
*/
count?: number;
/**
* Bucket range on which histogram was performed for the numeric field, that
* is, the count represents number of jobs in this range.
*/
range?: Schema$BucketRange;
}
/**
* Represents starting and ending value of a range in double.
*/
interface Schema$BucketRange {
/**
* Starting value of the bucket range.
*/
from?: number;
/**
* Ending value of the bucket range.
*/
to?: number;
}
/**
* An event issued when an end user interacts with the application that
* implements Cloud Talent Solution. Providing this information improves the
* quality of search and recommendation 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.
*/
interface Schema$ClientEvent {
/**
* Required. The timestamp of the event.
*/
createTime?: string;
/**
* Required. A unique identifier, generated by the client application. This
* `event_id` is used to establish the relationship between different events
* (see parent_event_id).
*/
eventId?: string;
/**
* Optional. Extra information about this event. Used for storing
* information with no matching field in event payload, for example, user
* application specific context or details. At most 20 keys are supported.
* The maximum total size of all keys and values is 2 KB.
*/
extraInfo?: {
[key: string]: string;
};
/**
* A event issued when a job seeker interacts with the application that
* implements Cloud Talent Solution.
*/
jobEvent?: Schema$JobEvent;
/**
* Optional. The event_id of an event that resulted in the current event.
* For example, a Job view event usually follows a parent impression event:
* A job seeker first does a search where a list of jobs appears
* (impression). The job seeker then selects a result and views the
* description of a particular job (Job view).
*/
parentEventId?: string;
/**
* Required. A unique ID generated in the API responses. It can be found in
* ResponseMetadata.request_id.
*/
requestId?: string;
}
/**
* Input only. Parameters needed for commute search.
*/
interface Schema$CommuteFilter {
/**
* Optional. 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 is not specified, only jobs that include street level
* addresses will be returned by commute search.
*/
allowImpreciseAddresses?: boolean;
/**
* Required. The method of transportation for which to calculate the
* commute time.
*/
commuteMethod?: string;
/**
* Optional. 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;
/**
* Optional. Specifies the traffic density to use when calculating commute
* time.
*/
roadTraffic?: string;
/**
* Required. The latitude and longitude of the location from which to
* calculate the commute time.
*/
startCoordinates?: Schema$LatLng;
/**
* Required. The maximum travel time in seconds. The maximum allowed value
* is `3600s` (one hour). Format is `123s`.
*/
travelDuration?: string;
}
/**
* Output only. Commute details related to this job.
*/
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 is not
* reachable within the requested duration, but was returned as part of an
* expanded query.
*/
travelDuration?: string;
}
/**
* 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.
*/
interface Schema$Company {
/**
* Optional. The URI to employer's career site or careers page on the
* employer's web site, for example,
* "https://careers.google.com".
*/
careerSiteUri?: string;
/**
* Output only. Derived details about the company.
*/
derivedInfo?: Schema$CompanyDerivedInfo;
/**
* Required. The display name of the company, for example, "Google,
* LLC".
*/
displayName?: string;
/**
* Optional. 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;
/**
* Required. Client side company identifier, used to uniquely identify the
* company. The maximum number of allowed characters is 255.
*/
externalId?: string;
/**
* Optional. 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;
/**
* Optional. Set to true if it is the hiring agency that post jobs for
* other employers. Defaults to false if not provided.
*/
hiringAgency?: boolean;
/**
* Optional. A URI that hosts the employer's company logo.
*/
imageUri?: string;
/**
* Optional. A list of keys of filterable Job.custom_attributes, whose
* corresponding `string_values` are used in keyword search. Jobs with
* `string_values` under these specified field keys are returned if any of
* the values matches the search keyword. Custom field values with
* parenthesis, brackets and special symbols won't be properly
* searchable, and those keyword queries need to be surrounded by quotes.
*/
keywordSearchableJobCustomAttributes?: string[];
/**
* 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}/companies/{company_id}", for example,
* "projects/api-test-project/companies/foo".
*/
name?: string;
/**
* Optional. The employer's company size.
*/
size?: string;
/**
* 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;
/**
* Optional. 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;
}
/**
* Derived details about the company.
*/
interface Schema$CompanyDerivedInfo {
/**
* A structured headquarters location of the company, resolved from
* Company.hq_location 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.
*/
interface Schema$CompensationEntry {
/**
* Optional. Compensation amount.
*/
amount?: Schema$Money;
/**
* Optional. Compensation description. For example, could indicate equity
* terms or provide additional context to an estimated bonus.
*/
description?: string;
/**
* Optional. 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;
/**
* Optional. Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Optional. Compensation type. Default is
* CompensationUnit.OTHER_COMPENSATION_TYPE.
*/
type?: string;
/**
* Optional. Frequency of the specified amount. Default is
* CompensationUnit.OTHER_COMPENSATION_UNIT.
*/
unit?: string;
}
/**
* Input only. Filter on job compensation type and amount.
*/
interface Schema$CompensationFilter {
/**
* Optional. Whether to include jobs whose compensation range is
* unspecified.
*/
includeJobsWithUnspecifiedCompensationRange?: boolean;
/**
* Optional. Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Required. Type of filter.
*/
type?: string;
/**
* Required. Specify desired `base compensation entry's`
* CompensationInfo.CompensationUnit.
*/
units?: string[];
}
/**
* Input only. Compensation based histogram request.
*/
interface Schema$CompensationHistogramRequest {
/**
* Required. Numeric histogram options, like buckets, whether include min
* or max value.
*/
bucketingOption?: Schema$NumericBucketingOption;
/**
* Required. Type of the request, representing which field the
* histogramming should be performed over. A single request can only specify
* one histogram of each `CompensationHistogramRequestType`.
*/
type?: string;
}
/**
* Output only. Compensation based histogram result.
*/
interface Schema$CompensationHistogramResult {
/**
* Histogram result.
*/
result?: Schema$NumericBucketingResult;
/**
* Type of the request, corresponding to CompensationHistogramRequest.type.
*/
type?: string;
}
/**
* Job compensation details.
*/
interface Schema$CompensationInfo {
/**
* Output only. Annualized base compensation range. Computed as base
* compensation entry's CompensationEntry.compensation 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.compensation times
* CompensationEntry.expected_units_per_year. See CompensationEntry for
* explanation on compensation annualization.
*/
annualizedTotalCompensationRange?: Schema$CompensationRange;
/**
* Optional. 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.
*/
interface Schema$CompensationRange {
/**
* Optional. 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;
/**
* Optional. 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;
}
/**
* Output only. Response of auto-complete query.
*/
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;
}
/**
* Output only. Resource that represents completion results.
*/
interface Schema$CompletionResult {
/**
* The URI of the company image for CompletionType.COMPANY_NAME.
*/
imageUri?: string;
/**
* The suggestion for the query.
*/
suggestion?: string;
/**
* The completion topic.
*/
type?: string;
}
/**
* The report event request.
*/
interface Schema$CreateClientEventRequest {
/**
* Required. Events issued when end user interacts with customer's
* application that uses Cloud Talent Solution.
*/
clientEvent?: Schema$ClientEvent;
}
/**
* Input only. The Request of the CreateCompany method.
*/
interface Schema$CreateCompanyRequest {
/**
* Required. The company to be created.
*/
company?: Schema$Company;
}
/**
* Input only. Create job request.
*/
interface Schema$CreateJobRequest {
/**
* Required. The Job to be created.
*/
job?: Schema$Job;
}
/**
* Custom attribute values that are either filterable or non-filterable.
*/
interface Schema$CustomAttribute {
/**
* Optional. If the `filterable` flag is true, custom field values are
* searchable. If false, values are not searchable. Default is false.
*/
filterable?: boolean;
/**
* Optional but 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[];
/**
* Optional but 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 255B.
* For unfilterable `string_values`, the maximum total byte size of
* unfilterable `string_values` is 50KB. Empty string is not allowed.
*/
stringValues?: string[];
}
/**
* Custom attributes histogram request. An error is thrown if neither
* string_value_histogram or long_value_histogram_bucketing_option has been
* defined.
*/
interface Schema$CustomAttributeHistogramRequest {
/**
* Required. Specifies the custom field key to perform a histogram on. If
* specified without `long_value_histogram_bucketing_option`, histogram on
* string values of the given `key` is triggered, otherwise histogram is
* performed on long values.
*/
key?: string;
/**
* Optional. Specifies buckets used to perform a range histogram on
* Job's filterable long custom field values, or min/max value
* requirements.
*/
longValueHistogramBucketingOption?: Schema$NumericBucketingOption;
/**
* Optional. If set to true, the response includes the histogram value for
* each key as a string.
*/
stringValueHistogram?: boolean;
}
/**
* Output only. Custom attribute histogram result.
*/
interface Schema$CustomAttributeHistogramResult {
/**
* Stores the key of custom attribute the histogram is performed on.
*/
key?: string;
/**
* Stores bucketed histogram counting result or min/max values for custom
* attribute long values associated with `key`.
*/
longValueHistogramResult?: Schema$NumericBucketingResult;
/**
* Stores a map from the values of string custom field associated with `key`
* to the number of jobs with that value in this histogram result.
*/
stringValueHistogramResult?: {
[key: string]: number;
};
}
/**
* Input only. Custom ranking information for SearchJobsRequest.
*/
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;
/**
* Required. Controls over how job documents get ranked on top of existing
* relevance score (determined by API algorithm). The product of 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. Sample ranking
* expression (year + 25) * 0.25 - (freshness / 0.5)
*/
rankingExpression?: string;
}
/**
* 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.
*/
interface Schema$DeviceInfo {
/**
* Optional. Type of the device.
*/
deviceType?: string;
/**
* Optional. A device-specific ID. The ID must be a unique identifier that
* distinguishes the device from other devices.
*/
id?: string;
}
/**
* 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 `{}`.
*/
interface Schema$Empty {
}
/**
* Input only. Histogram facets to be specified in SearchJobsRequest.
*/
interface Schema$HistogramFacets {
/**
* Optional. Specifies compensation field-based histogram requests.
* Duplicate values of CompensationHistogramRequest.type are not allowed.
*/
compensationHistogramFacets?: Schema$CompensationHistogramRequest[];
/**
* Optional. Specifies the custom attributes histogram requests. Duplicate
* values of CustomAttributeHistogramRequest.key are not allowed.
*/
customAttributeHistogramFacets?: Schema$CustomAttributeHistogramRequest[];
/**
* Optional. Specifies the simple type of histogram facets, for example,
* `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.
*/
simpleHistogramFacets?: string[];
}
/**
* Input Only. The histogram request.
*/
interface Schema$HistogramQuery {
/**
* An expression specifies a histogram request against matching resources
* (for example, jobs) for searches. Expression syntax is a aggregation
* function call with histogram facets and other options. Available
* aggregation function calls are: * `count(string_histogram_facet)`: Count
* the number of matching entity, for each distinct attribute value. *
* `count(numeric_histogram_facet, list of buckets)`: Count the number of
* matching entity 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_id: histogram by
* [Job.distributor_company_id. * 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.publish_time in months. Must
* specify list of numeric buckets in spec. * publish_time_in_year:
* histogram by the Job.publish_time in years. Must specify list of numeric
* buckets in spec. * degree_type: histogram by the Job.degree_type. 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 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"])
*/
histogramQuery?: string;
}
/**
* Output only. Histogram result that matches HistogramSpec specified in
* searches.
*/
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
* `<low>-<high>`, for example, `0-1000`, `MIN-0`, and `0-MAX`.
*/
histogram?: {
[key: string]: string;
};
/**
* Requested histogram expression.
*/
histogramQuery?: string;
}
/**
* Output only. Result of a histogram call. The response contains the
* histogram map for the search type specified by HistogramResult.field. The
* response is a map of each filter value to the corresponding count of jobs
* for that filter.
*/
interface Schema$HistogramResult {
/**
* The Histogram search filters.
*/
searchType?: string;
/**
* A map from the values of field to the number of jobs with that value in
* this search result. Key: search type (filter names, such as the
* companyName). Values: the count of jobs that match the filter for this
* search.
*/
values?: {
[key: string]: number;
};
}
/**
* Output only. Histogram results that match HistogramFacets specified in
* SearchJobsRequest.
*/
interface Schema$HistogramResults {
/**
* Specifies compensation field-based histogram results that match
* HistogramFacets.compensation_histogram_requests.
*/
compensationHistogramResults?: Schema$CompensationHistogramResult[];
/**
* Specifies histogram results for custom attributes that match
* HistogramFacets.custom_attribute_histogram_facets.
*/
customAttributeHistogramResults?: Schema$CustomAttributeHistogramResult[];
/**
* Specifies histogram results that matches
* HistogramFacets.simple_histogram_facets.
*/
simpleHistogramResults?: Schema$HistogramResult[];
}
/**
* 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.
*/
interface Schema$Job {
/**
* Optional but 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', etc.) as multiple jobs with the same company_name,
* 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. The maximum number
* of allowed characters is 500.
*/
addresses?: string[];
/**
* Required. At least one field within ApplicationInfo must be specified.
* Job application information.
*/
applicationInfo?: Schema$ApplicationInfo;
/**
* Output only. Display name of the company listing the job.
*/
companyDisplayName?: string;
/**
* Required. The resource name of the company listing the job, such as
* "projects/api-test-project/companies/foo".
*/
companyName?: string;
/**
* Optional. Job compensation information.
*/
compensationInfo?: Schema$CompensationInfo;
/**
* Optional. 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;
};
/**
* Optional. The desired education degrees for the job, such as Bachelors,
* Masters.
*/
degreeTypes?: string[];
/**
* Optional. The department or functional area within the company with the
* open position. The maximum number of allowed characters is 255.
*/
department?: string;
/**
* 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;
/**
* Optional. The employment type(s) of a job, for example, full time or
* part time.
*/
employmentTypes?: string[];
/**
* Optional. 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;
/**
* Optional. The benefits included with the job.
*/
jobBenefits?: string[];
/**
* Optional. The end timestamp of the job. Typically this field is used for
* contracting engagements. Invalid timestamps are ignored.
*/
jobEndTime?: string;
/**
* Optional. The experience level associated with the job, such as
* "Entry Level".
*/
jobLevel?: string;
/**
* Optional. The start timestamp of the job in UTC time zone. Typically
* this field is used for contracting engagements. Invalid timestamps are
* ignored.
*/
jobStartTime?: string;
/**
* Optional. 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;
/**
* 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}/jobs/{job_id}", for example,
* "projects/api-test-project/jobs/1234". 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;
/**
* Output only. The timestamp when this job posting was created.
*/
postingCreateTime?: string;
/**
* Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it
* can be retrieved with the GetJob API or updated with the UpdateJob 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_name, 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
* of open jobs count over the past week, otherwise jobs with earlier expire
* time are cleaned first. Expired jobs are no longer accessible after they
* are cleaned out. Invalid timestamps are ignored, and treated as expire
* time not provided. Timestamp before the instant request is made is
* considered valid, the job will be treated as expired immediately. If
* this value is not 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 is not provided on job update, it depends on the
* field masks set by UpdateJobRequest.update_mask. If the field masks
* include expiry_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;
/**
* Optional. 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;
/**
* Optional. 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;
/**
* Output only. The timestamp when this job posting was last updated.
*/
postingUpdateTime?: string;
/**
* Optional. Options for job processing.
*/
processingOptions?: Schema$ProcessingOptions;
/**
* Optional. 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;
/**
* Optional. 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;
/**
* Required. The requisition ID, also referred to as the posting ID,
* 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
* is not allowed to be created if there is another job with the same
* [company_name], language_code and requisition_id. The maximum number of
* allowed characters is 255.
*/
requisitionId?: string;
/**
* Optional. 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;
/**
* Required. The title of the job, such as "Software Engineer"
* The maximum number of allowed characters is 500.
*/
title?: string;
/**
* Optional. The visibility of the job. Defaults to
* Visibility.ACCOUNT_ONLY if not specified.
*/
visibility?: string;
}
/**
* Output only. Derived details about the job posting.
*/
interface Schema$JobDerivedInfo {
/**
* Job categories derived from Job.title and Job.description.
*/
jobCategories?: string[];
/**
* 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.
*/
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.
*/
jobs?: string[];
/**
* Required. The type of the event (see JobEventType).
*/
type?: string;
}
/**
* Input only. The query required to perform a search query.
*/
interface Schema$JobQuery {
/**
* Optional. Allows filtering jobs by commute time with different travel
* methods (for example, driving or public transit). Note: This only works
* with COMMUTE MODE. When specified, [JobQuery.location_filters] is
* ignored. Currently we don't support sorting by commute time.
*/
commuteFilter?: Schema$CommuteFilter;
/**
* Optional. This filter specifies the exact 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[];
/**
* Optional. 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}/companies/{company_id}", for example,
* "projects/api-test-project/companies/foo". At most 20 company
* filters are allowed.
*/
companyNames?: string[];
/**
* Optional. 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;
/**
* Optional. 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 < 3000 bytes in length. Sample
* Query: `(LOWER(driving_license)="class \"a\"" OR
* EMPTY(driving_license)) AND driving_years > 10`
*/
customAttributeFilter?: string;
/**
* Optional. 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;
/**
* Optional. The employment type filter specifies the employment type of
* jobs to search against, such as EmploymentType.FULL_TIME. If a value is
* not 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[];
/**
* Optional. This filter specifies a list of job names to be excluded
* during search. At most 200 excluded job names are allowed.
*/
excludedJobs?: string[];
/**
* Optional. The category filter specifies the categories of jobs to search
* against. See Category for more information. If a value is not 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[];
/**
* Optional. 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[];
/**
* Optional. 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[];
/**
* Optional. Jobs published within a range specified by this filter are
* searched against.
*/
publishTimeRange?: Schema$TimestampRange;
/**
* Optional. The query string that matches against the job title,
* description, and location fields. The maximum number of allowed
* characters is 255.
*/
query?: string;
}
/**
* An object representing a latitude/longitude pair. This is expressed as a
* pair of doubles representing degrees latitude and degrees longitude. Unless
* specified otherwise, this must conform to the <a
* href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
* standard</a>. Values must be within normalized ranges.
*/
interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number;
}
/**
* Output only. The List companies response object.
*/
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;
}
/**
* Output only. List jobs response.
*/
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;
}
/**
* Output only. A resource that represents a location with full geographic
* information.
*/
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
* 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;
/**
* 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 LatLng covers the area associated with the job location.
* For example, currently, "Mountain View, CA, USA" has a radius
* of 6.17 miles.
*/
radiusInMiles?: number;
}
/**
* Input only. Geographic region of the search.
*/
interface Schema$LocationFilter {
/**
* Optional. The address name, such as "Mountain View" or
* "Bay Area".
*/
address?: string;
/**
* Optional. The distance_in_miles is applied when the location being
* searched for is identified as a city or smaller. When the location being
* searched for is a state or larger, this field is ignored.
*/
distanceInMiles?: number;
/**
* Optional. The latitude and longitude of the geographic center from which
* to search. This field's ignored if `address` is provided.
*/
latLng?: Schema$LatLng;
/**
* Optional. CLDR region code of the country/region of the address. This is
* used to address ambiguity of the user-input location, for example,
* "Liverpool" against "Liverpool, NY, US" or
* "Liverpool, UK". Set this field if all the jobs to search
* against are from a same region, or jobs are world-wide, but the job
* seeker is from a specific region. 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;
/**
* Optional. Allows the client to return jobs without a set location,
* specifically, telecommuting jobs (telecomuting 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.
*/
telecommutePreference?: string;
}
/**
* Output only. Job entry with metadata inside SearchJobsResponse.
*/
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;
/**
* Contains snippets of text from the Job.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;
/**
* 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;
}
/**
* Represents an amount of money with its currency type.
*/
interface Schema$Money {
/**
* The 3-letter currency code defined in ISO 4217.
*/
currencyCode?: string;
/**
* 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;
/**
* The whole units of the amount. For example if `currencyCode` is
* `"USD"`, then 1 unit is one US dollar.
*/
units?: string;
}
/**
* Input only. Use this field to specify bucketing option for the histogram
* search response.
*/
interface Schema$NumericBucketingOption {
/**
* Required. Two adjacent values form a histogram bucket. Values should be
* in ascending order. For example, if [5, 10, 15] are provided, four
* buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
* [buckets_bound is supported.
*/
bucketBounds?: number[];
/**
* Optional. If set to true, the histogram result includes minimum/maximum
* value of the numeric field.
*/
requiresMinMax?: boolean;
}
/**
* Output only. Custom numeric bucketing result.
*/
interface Schema$NumericBucketingResult {
/**
* Count within each bucket. Its size is the length of
* NumericBucketingOption.bucket_bounds plus 1.
*/
counts?: Schema$BucketizedCount[];
/**
* Stores the maximum value of the numeric field. Is populated only if
* [NumericBucketingOption.requires_min_max] is set to true.
*/
maxValue?: number;
/**
* Stores the minimum value of the numeric field. Will be populated only if
* [NumericBucketingOption.requires_min_max] is set to true.
*/
minValue?: number;
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
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;
/**
* 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;
};
/**
* 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 have the format of `operations/some/unique/name`.
*/
name?: string;
/**
* 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;
};
}
/**
* 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/googlei18n/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
*/
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[];
/**
* 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;
/**
* 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;
/**
* 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;
/**
* Optional. The name of the organization at the address.
*/
organization?: string;
/**
* 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;
/**
* 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[];
/**
* 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;
/**
* 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;
/**
* 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;
/**
* Optional. Sublocality of the address. For example, this can be
* neighborhoods, boroughs, districts.
*/
sublocality?: string;
}
/**
* Input only. Options for job processing.
*/
interface Schema$ProcessingOptions {
/**
* Optional. If set to `true`, the service does not attempt to resolve a
* more precise address for the job.
*/
disableStreetAddressResolution?: boolean;
/**
* Optional. 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 is not disabled. Defaults to
* HtmlSanitization.SIMPLE_FORMATTING_ONLY.
*/
htmlSanitization?: string;
}
/**
* Input only. Meta information related to the job searcher or entity
* conducting the job search. This information is used to improve the
* performance of the service.
*/
interface Schema$RequestMetadata {
/**
* Optional. The type of device used by the job seeker at the time of the
* call to the service.
*/
deviceInfo?: Schema$DeviceInfo;
/**
* Required. 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
* <em>Foo, Inc.</em>, 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. If this
* field isn't available for some reason, send "UNKNOWN". Any
* improvements to the model for a particular tenant site rely on this field
* being set correctly to a domain. The maximum number of allowed
* characters is 255.
*/
domain?: string;
/**
* Required. 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. If this field is not available for some
* reason, send "UNKNOWN". Note that any improvements to the model
* for a particular tenant site, rely on this field being set correctly to
* some unique session_id. The maximum number of allowed characters is 255.
*/
sessionId?: string;
/**
* Required. 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. If this field is not available for
* some reason, send "UNKNOWN". 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;
}
/**
* Output only. Additional information returned to client, such as debugging
* information.
*/
interface Schema$ResponseMetadata {
/**
* A unique id associated with this call. This id is logged for tracking
* purposes.
*/
requestId?: string;
}
/**
* Input only. The Request body of the `SearchJobs` call.
*/
interface Schema$SearchJobsRequest {
/**
* Optional. Controls over how job documents get ranked on top of existing
* relevance score (determined by API algorithm).
*/
customRankingInfo?: Schema$CustomRankingInfo;
/**
* Optional. Controls whether to disable exact keyword match on
* Job.job_title, Job.description, Job.company_display_name, Job.locations,
* 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, the query "program
* manager," a result is returned even if the job posting has the title
* "software developer," which does not fall into "program
* manager" ontology, but does have "program manager"
* appearing in its description. For queries like "cloud" that
* does not contain title or location specific ontology, jobs with
* "cloud" keyword matches are returned regardless of this
* flag's value. Please use Company.keyword_searchable_custom_fields or
* Company.keyword_searchable_custom_attributes if company specific globally
* matched custom field/attribute string values is needed. Enabling keyword
* match improves recall of subsequent search requests. Defaults to false.
*/
disableKeywordMatch?: boolean;
/**
* Optional. 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;
/**
* Optional. 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;
/**
* Optional. Histogram requests for jobs matching JobQuery.
*/
histogramFacets?: Schema$HistogramFacets;
/**
* Optional. Expression based histogram requests for jobs matching
* JobQuery.
*/
histogramQueries?: Schema$HistogramQuery[];
/**
* Optional. Query used to search against jobs, such as keyword, location
* filters, etc.
*/
jobQuery?: Schema$JobQuery;
/**
* Optional. The desired job attributes returned for jobs in the search
* response. Defaults to JobView.SMALL if no value is specified.
*/
jobView?: string;
/**
* Optional. 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.
* 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;
/**
* Optional. 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.custom_ranking_info.ranking_expression with weight
* factor assigned by SearchJobsRequest.custom_ranking_info.importance_level
* in descending order. * "location`_`distance": By the distance
* between the location on jobs and locations specified in the
* SearchJobsRequest.job_query.location_filters. When this order is
* selected, the SearchJobsRequest.job_query.location_filters must not be
* empty. When a job has multiple locations, the location closest to one of
* the locations specified in the location filter will be used to calculate
* location distance. Distance is calculated by the distance between two
* lat/long coordinates, with a precision of 10e-4 degrees (11.3 meters).
* Jobs that don't have locations specified will be ranked below jobs
* having locations. Diversification strategy is still applied unless
* explicitly disabled in SearchJobsRequest.diversification_level.
*/
orderBy?: string;
/**
* Optional. 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.
*/
pageSize?: number;
/**
* Optional. 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;
/**
* 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;
/**
* Optional. Controls if the search job request requires the return of a
* precise count of the first 300 results. Setting this to `true` ensures
* consistency in the number of results per page. Best practice is to set
* this value to true if a client allows users to jump directly to a
* non-sequential search results page. Enabling this flag may adversely
* impact performance. Defaults to false.
*/
requirePreciseResultSize?: boolean;
/**
* Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH.
*/
searchMode?: string;
}
/**
* Output only. Response for SearchJob method.
*/
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;
/**
* An estimation of the number of jobs that match the specified query. This
* number is not guaranteed to be accurate. For accurate results, see
* enable_precise_result_size.
*/
estimatedTotalSize?: number;
/**
* The histogram results that match with specified
* SearchJobsRequest.histogram_queries.
*/
histogramQueryResults?: Schema$HistogramQueryResult[];
/**
* The histogram results that match specified
* SearchJobsRequest.histogram_facets.
*/
histogramResults?: Schema$HistogramResults;
/**
* The location filters that the service applied to the specified query. If
* any filters are lat-lng based, the JobLocation.location_type is
* JobLocation.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;
/**
* The spell checking result, and correction.
*/
spellCorrection?: Schema$SpellingCorrection;
/**
* The precise result count, which is available only if the client set
* enable_precise_result_size to `true`, or if the response is the last page
* of results. Otherwise, the value is `-1`.
*/
totalSize?: number;
}
/**
* Output only. Spell check result.
*/
interface Schema$SpellingCorrection {
/**
* Indicates if the query was corrected by the spell checker.
*/
corrected?: boolean;
/**
* Correction output consisting of the corrected keyword string.
*/
correctedText?: string;
}
/**
* 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). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* 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;
}>;
/**
* 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;
}
/**
* 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`.
*/
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;
/**
* Minutes of hour of day. Must be from 0 to 59.
*/
minutes?: number;
/**
* Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
*/
nanos?: number;
/**
* 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;
}
/**
* Message representing a period of time between two timestamps.
*/
interface Schema$TimestampRange {
/**
* End of the period.
*/
endTime?: string;
/**
* Begin of the period.
*/
startTime?: string;
}
/**
* Input only. Request for updating a specified company.
*/
interface Schema$UpdateCompanyRequest {
/**
* Required. The company resource to replace the current resource in the
* system.
*/
company?: Schema$Company;
/**
* Optional but 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;
}
/**
* Input only. Update job request.
*/
interface Schema$UpdateJobRequest {
/**
* Required. The Job to be updated.
*/
job?: Schema$Job;
/**
* Optional but strongly recommended to be provided 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;
}
class Resource$Projects {
context: APIRequestContext;
clientEvents: Resource$Projects$Clientevents;
companies: Resource$Projects$Companies;
jobs: Resource$Projects$Jobs;
operations: Resource$Projects$Operations;
constructor(context: APIRequestContext);
/**
* jobs.projects.complete
* @desc Completes the specified prefix with keyword suggestions. Intended
* for use by a job search auto-complete search box.
* @alias jobs.projects.complete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
* @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language 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). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255.
* @param {string=} params.languageCodes Optional. 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). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255.
* @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project".
* @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10.
* @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
* @param {string=} params.scope Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
* @param {string=} params.type Optional. The completion topic. The default is CompletionType.COMBINED.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
complete(params?: Params$Resource$Projects$Complete, options?: MethodOptions): GaxiosPromise<Schema$CompleteQueryResponse>;
complete(params: Params$Resource$Projects$Complete, options: MethodOptions | BodyResponseCallback<Schema$CompleteQueryResponse>, callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
complete(params: Params$Resource$Projects$Complete, callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
complete(callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
}
interface Params$Resource$Projects$Complete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. If provided, restricts completion to specified company. The
* format is "projects/{project_id}/companies/{company_id}", for example,
* "projects/api-test-project/companies/foo".
*/
companyName?: string;
/**
* Deprecated. Use language_codes instead. Optional. The language 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). For
* CompletionType.JOB_TITLE type, only open jobs with the same language_code
* are returned. For CompletionType.COMPANY_NAME type, only companies
* having open jobs with the same language_code are returned. For
* CompletionType.COMBINED type, only open jobs with the same language_code
* or companies having open jobs with the same language_code are returned.
* The maximum number of allowed characters is 255.
*/
languageCode?: string;
/**
* Optional. 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). For
* CompletionType.JOB_TITLE type, only open jobs with the same
* language_codes are returned. For CompletionType.COMPANY_NAME type, only
* companies having open jobs with the same language_codes are returned. For
* CompletionType.COMBINED type, only open jobs with the same language_codes
* or companies having open jobs with the same language_codes are returned.
* The maximum number of allowed characters is 255.
*/
languageCodes?: string[];
/**
* Required. Resource name of project the completion is performed within.
* The format is "projects/{project_id}", for example,
* "projects/api-test-project".
*/
name?: 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;
/**
* Optional. The scope of the completion. The defaults is
* CompletionScope.PUBLIC.
*/
scope?: string;
/**
* Optional. The completion topic. The default is CompletionType.COMBINED.
*/
type?: string;
}
class Resource$Projects$Clientevents {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* jobs.projects.clientEvents.create
* @desc 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/job-search/docs/management-tools)
* about self service tools.
* @alias jobs.projects.clientEvents.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Parent project name.
* @param {().CreateClientEventRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Clientevents$Create, options?: MethodOptions): GaxiosPromise<Schema$ClientEvent>;
create(params: Params$Resource$Projects$Clientevents$Create, options: MethodOptions | BodyResponseCallback<Schema$ClientEvent>, callback: BodyResponseCallback<Schema$ClientEvent>): void;
create(params: Params$Resource$Projects$Clientevents$Create, callback: BodyResponseCallback<Schema$ClientEvent>): void;
create(callback: BodyResponseCallback<Schema$ClientEvent>): void;
}
interface Params$Resource$Projects$Clientevents$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Parent project name.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateClientEventRequest;
}
class Resource$Projects$Companies {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* jobs.projects.companies.create
* @desc Creates a new company entity.
* @alias jobs.projects.companies.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project".
* @param {().CreateCompanyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Companies$Create, options?: MethodOptions): GaxiosPromise<Schema$Company>;
create(params: Params$Resource$Projects$Companies$Create, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
create(params: Params$Resource$Projects$Companies$Create, callback: BodyResponseCallback<Schema$Company>): void;
create(callback: BodyResponseCallback<Schema$Company>): void;
/**
* jobs.projects.companies.delete
* @desc Deletes specified company. Prerequisite: The company has no jobs
* associated with it.
* @alias jobs.projects.companies.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Companies$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Companies$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Companies$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* jobs.projects.companies.get
* @desc Retrieves specified company.
* @alias jobs.projects.companies.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Companies$Get, options?: MethodOptions): GaxiosPromise<Schema$Company>;
get(params: Params$Resource$Projects$Companies$Get, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
get(params: Params$Resource$Projects$Companies$Get, callback: BodyResponseCallback<Schema$Company>): void;
get(callback: BodyResponseCallback<Schema$Company>): void;
/**
* jobs.projects.companies.list
* @desc Lists all companies associated with the service account.
* @alias jobs.projects.companies.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.
* @param {string=} params.pageToken Optional. The starting indicator from which to return results.
* @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project".
* @param {boolean=} params.requireOpenJobs Optional. 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.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Companies$List, options?: MethodOptions): GaxiosPromise<Schema$ListCompaniesResponse>;
list(params: Params$Resource$Projects$Companies$List, options: MethodOptions | BodyResponseCallback<Schema$ListCompaniesResponse>, callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
list(params: Params$Resource$Projects$Companies$List, callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
/**
* jobs.projects.companies.patch
* @desc Updates specified company. Company names can't be updated. To
* update a company name, delete the company and all jobs associated with
* it, and only then re-create them.
* @alias jobs.projects.companies.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
* @param {().UpdateCompanyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Companies$Patch, options?: MethodOptions): GaxiosPromise<Schema$Company>;
patch(params: Params$Resource$Projects$Companies$Patch, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
patch(params: Params$Resource$Projects$Companies$Patch, callback: BodyResponseCallback<Schema$Company>): void;
patch(callback: BodyResponseCallback<Schema$Company>): void;
}
interface Params$Resource$Projects$Companies$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name of the project under which the company is
* created. The format is "projects/{project_id}", for example,
* "projects/api-test-project".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateCompanyRequest;
}
interface Params$Resource$Projects$Companies$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the company to be deleted. The format is
* "projects/{project_id}/companies/{company_id}", for example,
* "projects/api-test-project/companies/foo".
*/
name?: string;
}
interface Params$Resource$Projects$Companies$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the company to be retrieved. The format
* is "projects/{project_id}/companies/{company_id}", for example,
* "projects/api-test-project/companies/foo".
*/
name?: string;
}
interface Params$Resource$Projects$Companies$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of companies to be returned, at most 100.
* Default is 100 if a non-positive number is provided.
*/
pageSize?: number;
/**
* Optional. The starting indicator from which to return results.
*/
pageToken?: string;
/**
* Required. Resource name of the project under which the company is
* created. The format is "projects/{project_id}", for example,
* "projects/api-test-project".
*/
parent?: string;
/**
* Optional. 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;
}
interface Params$Resource$Projects$Companies$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* 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}/companies/{company_id}", for example,
* "projects/api-test-project/companies/foo".
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateCompanyRequest;
}
class Resource$Projects$Jobs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* jobs.projects.jobs.batchDelete
* @desc Deletes a list of Jobs by filter.
* @alias jobs.projects.jobs.batchDelete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project".
* @param {().BatchDeleteJobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchDelete(params?: Params$Resource$Projects$Jobs$Batchdelete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
batchDelete(params: Params$Resource$Projects$Jobs$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
batchDelete(params: Params$Resource$Projects$Jobs$Batchdelete, callback: BodyResponseCallback<Schema$Empty>): void;
batchDelete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* jobs.projects.jobs.create
* @desc Creates a new job. Typically, the job becomes searchable within 10
* seconds, but it may take up to 5 minutes.
* @alias jobs.projects.jobs.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project".
* @param {().CreateJobRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Jobs$Create, options?: MethodOptions): GaxiosPromise<Schema$Job>;
create(params: Params$Resource$Projects$Jobs$Create, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
create(params: Params$Resource$Projects$Jobs$Create, callback: BodyResponseCallback<Schema$Job>): void;
create(callback: BodyResponseCallback<Schema$Job>): void;
/**
* jobs.projects.jobs.delete
* @desc Deletes the specified job. Typically, the job becomes unsearchable
* within 10 seconds, but it may take up to 5 minutes.
* @alias jobs.projects.jobs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Jobs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Jobs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Jobs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* jobs.projects.jobs.get
* @desc Retrieves the specified job, whose status is OPEN or recently
* EXPIRED within the last 90 days.
* @alias jobs.projects.jobs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Jobs$Get, options?: MethodOptions): GaxiosPromise<Schema$Job>;
get(params: Params$Resource$Projects$Jobs$Get, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
get(params: Params$Resource$Projects$Jobs$Get, callback: BodyResponseCallback<Schema$Job>): void;
get(callback: BodyResponseCallback<Schema$Job>): void;
/**
* jobs.projects.jobs.list
* @desc Lists jobs by filter.
* @alias jobs.projects.jobs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1"
* @param {string=} params.jobView Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.
* @param {integer=} params.pageSize Optional. 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.
* @param {string=} params.pageToken Optional. The starting point of a query result.
* @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Jobs$List, options?: MethodOptions): GaxiosPromise<Schema$ListJobsResponse>;
list(params: Params$Resource$Projects$Jobs$List, options: MethodOptions | BodyResponseCallback<Schema$ListJobsResponse>, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
list(params: Params$Resource$Projects$Jobs$List, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
/**
* jobs.projects.jobs.patch
* @desc Updates specified job. Typically, updated contents become visible
* in search results within 10 seconds, but it may take up to 5 minutes.
* @alias jobs.projects.jobs.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
* @param {().UpdateJobRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Jobs$Patch, options?: MethodOptions): GaxiosPromise<Schema$Job>;
patch(params: Params$Resource$Projects$Jobs$Patch, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
patch(params: Params$Resource$Projects$Jobs$Patch, callback: BodyResponseCallback<Schema$Job>): void;
patch(callback: BodyResponseCallback<Schema$Job>): void;
/**
* jobs.projects.jobs.search
* @desc 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.
* @alias jobs.projects.jobs.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project".
* @param {().SearchJobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Projects$Jobs$Search, options?: MethodOptions): GaxiosPromise<Schema$SearchJobsResponse>;
search(params: Params$Resource$Projects$Jobs$Search, options: MethodOptions | BodyResponseCallback<Schema$SearchJobsResponse>, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
search(params: Params$Resource$Projects$Jobs$Search, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
search(callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
/**
* jobs.projects.jobs.searchForAlert
* @desc 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), and has different algorithmic adjustments
* that are targeted to 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.
* @alias jobs.projects.jobs.searchForAlert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project".
* @param {().SearchJobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
searchForAlert(params?: Params$Resource$Projects$Jobs$Searchforalert, options?: MethodOptions): GaxiosPromise<Schema$SearchJobsResponse>;
searchForAlert(params: Params$Resource$Projects$Jobs$Searchforalert, options: MethodOptions | BodyResponseCallback<Schema$SearchJobsResponse>, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
searchForAlert(params: Params$Resource$Projects$Jobs$Searchforalert, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
searchForAlert(callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
}
interface Params$Resource$Projects$Jobs$Batchdelete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the project under which the job is
* created. The format is "projects/{project_id}", for example,
* "projects/api-test-project".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchDeleteJobsRequest;
}
interface Params$Resource$Projects$Jobs$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the project under which the job is
* created. The format is "projects/{project_id}", for example,
* "projects/api-test-project".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateJobRequest;
}
interface Params$Resource$Projects$Jobs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the job to be deleted. The format is
* "projects/{project_id}/jobs/{job_id}", for example,
* "projects/api-test-project/jobs/1234".
*/
name?: string;
}
interface Params$Resource$Projects$Jobs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the job to retrieve. The format is
* "projects/{project_id}/jobs/{job_id}", for example,
* "projects/api-test-project/jobs/1234".
*/
name?: string;
}
interface Params$Resource$Projects$Jobs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The filter string specifies the jobs to be enumerated.
* Supported operator: =, AND The fields eligible for filtering are: *
* `companyName` (Required) * `requisitionId` (Optional) Sample Query: *
* companyName = "projects/api-test-project/companies/123" * companyName =
* "projects/api-test-project/companies/123" AND requisitionId = "req-1"
*/
filter?: string;
/**
* Optional. The desired job attributes returned for jobs in the search
* response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.
*/
jobView?: string;
/**
* Optional. 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;
/**
* Optional. The starting point of a query result.
*/
pageToken?: string;
/**
* Required. The resource name of the project under which the job is
* created. The format is "projects/{project_id}", for example,
* "projects/api-test-project".
*/
parent?: string;
}
interface Params$Resource$Projects$Jobs$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* 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}/jobs/{job_id}", for example,
* "projects/api-test-project/jobs/1234". 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;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateJobRequest;
}
interface Params$Resource$Projects$Jobs$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the project to search within. The format
* is "projects/{project_id}", for example, "projects/api-test-project".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SearchJobsRequest;
}
interface Params$Resource$Projects$Jobs$Searchforalert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the project to search within. The format
* is "projects/{project_id}", for example, "projects/api-test-project".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SearchJobsRequest;
}
class Resource$Projects$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* jobs.projects.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use
* this method to poll the operation result at intervals as recommended by
* the API service.
* @alias jobs.projects.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
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;
}
interface Params$Resource$Projects$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
}