This repository has been archived by the owner on Sep 5, 2023. It is now read-only.
/
common.proto
860 lines (682 loc) · 31.2 KB
/
common.proto
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
// Copyright 2020 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.
syntax = "proto3";
package google.cloud.talent.v4;
import "google/api/field_behavior.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "google/type/latlng.proto";
import "google/type/money.proto";
import "google/type/postal_address.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4;talent";
option java_multiple_files = true;
option java_outer_classname = "CommonProto";
option java_package = "com.google.cloud.talent.v4";
option objc_class_prefix = "CTS";
// Message representing a period of time between two timestamps.
message TimestampRange {
// Begin of the period (inclusive).
google.protobuf.Timestamp start_time = 1;
// End of the period (exclusive).
google.protobuf.Timestamp end_time = 2;
}
// An enum that represents the size of the company.
enum CompanySize {
// Default value if the size isn't specified.
COMPANY_SIZE_UNSPECIFIED = 0;
// The company has less than 50 employees.
MINI = 1;
// The company has between 50 and 99 employees.
SMALL = 2;
// The company has between 100 and 499 employees.
SMEDIUM = 3;
// The company has between 500 and 999 employees.
MEDIUM = 4;
// The company has between 1,000 and 4,999 employees.
BIG = 5;
// The company has between 5,000 and 9,999 employees.
BIGGER = 6;
// The company has 10,000 or more employees.
GIANT = 7;
}
// An enum that represents employee benefits included with the job.
enum JobBenefit {
// Default value if the type isn't specified.
JOB_BENEFIT_UNSPECIFIED = 0;
// The job includes access to programs that support child care, such
// as daycare.
CHILD_CARE = 1;
// The job includes dental services covered by a dental
// insurance plan.
DENTAL = 2;
// The job offers specific benefits to domestic partners.
DOMESTIC_PARTNER = 3;
// The job allows for a flexible work schedule.
FLEXIBLE_HOURS = 4;
// The job includes health services covered by a medical insurance plan.
MEDICAL = 5;
// The job includes a life insurance plan provided by the employer or
// available for purchase by the employee.
LIFE_INSURANCE = 6;
// The job allows for a leave of absence to a parent to care for a newborn
// child.
PARENTAL_LEAVE = 7;
// The job includes a workplace retirement plan provided by the
// employer or available for purchase by the employee.
RETIREMENT_PLAN = 8;
// The job allows for paid time off due to illness.
SICK_DAYS = 9;
// The job includes paid time off for vacation.
VACATION = 10;
// The job includes vision services covered by a vision
// insurance plan.
VISION = 11;
}
// Educational degree level defined in International Standard Classification
// of Education (ISCED).
enum DegreeType {
// Default value. Represents no degree, or early childhood education.
// Maps to ISCED code 0.
// Ex) Kindergarten
DEGREE_TYPE_UNSPECIFIED = 0;
// Primary education which is typically the first stage of compulsory
// education. ISCED code 1.
// Ex) Elementary school
PRIMARY_EDUCATION = 1;
// Lower secondary education; First stage of secondary education building on
// primary education, typically with a more subject-oriented curriculum.
// ISCED code 2.
// Ex) Middle school
LOWER_SECONDARY_EDUCATION = 2;
// Middle education; Second/final stage of secondary education preparing for
// tertiary education and/or providing skills relevant to employment.
// Usually with an increased range of subject options and streams. ISCED
// code 3.
// Ex) High school
UPPER_SECONDARY_EDUCATION = 3;
// Adult Remedial Education; Programmes providing learning experiences that
// build on secondary education and prepare for labour market entry and/or
// tertiary education. The content is broader than secondary but not as
// complex as tertiary education. ISCED code 4.
ADULT_REMEDIAL_EDUCATION = 4;
// Associate's or equivalent; Short first tertiary programmes that are
// typically practically-based, occupationally-specific and prepare for
// labour market entry. These programmes may also provide a pathway to other
// tertiary programmes. ISCED code 5.
ASSOCIATES_OR_EQUIVALENT = 5;
// Bachelor's or equivalent; Programmes designed to provide intermediate
// academic and/or professional knowledge, skills and competencies leading
// to a first tertiary degree or equivalent qualification. ISCED code 6.
BACHELORS_OR_EQUIVALENT = 6;
// Master's or equivalent; Programmes designed to provide advanced academic
// and/or professional knowledge, skills and competencies leading to a
// second tertiary degree or equivalent qualification. ISCED code 7.
MASTERS_OR_EQUIVALENT = 7;
// Doctoral or equivalent; Programmes designed primarily to lead to an
// advanced research qualification, usually concluding with the submission
// and defense of a substantive dissertation of publishable quality based on
// original research. ISCED code 8.
DOCTORAL_OR_EQUIVALENT = 8;
}
// An enum that represents the employment type of a job.
enum EmploymentType {
// The default value if the employment type isn't specified.
EMPLOYMENT_TYPE_UNSPECIFIED = 0;
// The job requires working a number of hours that constitute full
// time employment, typically 40 or more hours per week.
FULL_TIME = 1;
// The job entails working fewer hours than a full time job,
// typically less than 40 hours a week.
PART_TIME = 2;
// The job is offered as a contracted, as opposed to a salaried employee,
// position.
CONTRACTOR = 3;
// The job is offered as a contracted position with the understanding
// that it's converted into a full-time position at the end of the
// contract. Jobs of this type are also returned by a search for
// [EmploymentType.CONTRACTOR][google.cloud.talent.v4.EmploymentType.CONTRACTOR] jobs.
CONTRACT_TO_HIRE = 4;
// The job is offered as a temporary employment opportunity, usually
// a short-term engagement.
TEMPORARY = 5;
// The job is a fixed-term opportunity for students or entry-level job
// seekers to obtain on-the-job training, typically offered as a summer
// position.
INTERN = 6;
// The is an opportunity for an individual to volunteer, where there's no
// expectation of compensation for the provided services.
VOLUNTEER = 7;
// The job requires an employee to work on an as-needed basis with a
// flexible schedule.
PER_DIEM = 8;
// The job involves employing people in remote areas and flying them
// temporarily to the work site instead of relocating employees and their
// families permanently.
FLY_IN_FLY_OUT = 9;
// The job does not fit any of the other listed types.
OTHER_EMPLOYMENT_TYPE = 10;
}
// An enum that represents the required experience level required for the job.
enum JobLevel {
// The default value if the level isn't specified.
JOB_LEVEL_UNSPECIFIED = 0;
// Entry-level individual contributors, typically with less than 2 years of
// experience in a similar role. Includes interns.
ENTRY_LEVEL = 1;
// Experienced individual contributors, typically with 2+ years of
// experience in a similar role.
EXPERIENCED = 2;
// Entry- to mid-level managers responsible for managing a team of people.
MANAGER = 3;
// Senior-level managers responsible for managing teams of managers.
DIRECTOR = 4;
// Executive-level managers and above, including C-level positions.
EXECUTIVE = 5;
}
// An enum that represents the categorization or primary focus of specific
// role. This value is different than the "industry" associated with a role,
// which is related to the categorization of the company listing the job.
enum JobCategory {
// The default value if the category isn't specified.
JOB_CATEGORY_UNSPECIFIED = 0;
// An accounting and finance job, such as an Accountant.
ACCOUNTING_AND_FINANCE = 1;
// An administrative and office job, such as an Administrative Assistant.
ADMINISTRATIVE_AND_OFFICE = 2;
// An advertising and marketing job, such as Marketing Manager.
ADVERTISING_AND_MARKETING = 3;
// An animal care job, such as Veterinarian.
ANIMAL_CARE = 4;
// An art, fashion, or design job, such as Designer.
ART_FASHION_AND_DESIGN = 5;
// A business operations job, such as Business Operations Manager.
BUSINESS_OPERATIONS = 6;
// A cleaning and facilities job, such as Custodial Staff.
CLEANING_AND_FACILITIES = 7;
// A computer and IT job, such as Systems Administrator.
COMPUTER_AND_IT = 8;
// A construction job, such as General Laborer.
CONSTRUCTION = 9;
// A customer service job, such s Cashier.
CUSTOMER_SERVICE = 10;
// An education job, such as School Teacher.
EDUCATION = 11;
// An entertainment and travel job, such as Flight Attendant.
ENTERTAINMENT_AND_TRAVEL = 12;
// A farming or outdoor job, such as Park Ranger.
FARMING_AND_OUTDOORS = 13;
// A healthcare job, such as Registered Nurse.
HEALTHCARE = 14;
// A human resources job, such as Human Resources Director.
HUMAN_RESOURCES = 15;
// An installation, maintenance, or repair job, such as Electrician.
INSTALLATION_MAINTENANCE_AND_REPAIR = 16;
// A legal job, such as Law Clerk.
LEGAL = 17;
// A management job, often used in conjunction with another category,
// such as Store Manager.
MANAGEMENT = 18;
// A manufacturing or warehouse job, such as Assembly Technician.
MANUFACTURING_AND_WAREHOUSE = 19;
// A media, communications, or writing job, such as Media Relations.
MEDIA_COMMUNICATIONS_AND_WRITING = 20;
// An oil, gas or mining job, such as Offshore Driller.
OIL_GAS_AND_MINING = 21;
// A personal care and services job, such as Hair Stylist.
PERSONAL_CARE_AND_SERVICES = 22;
// A protective services job, such as Security Guard.
PROTECTIVE_SERVICES = 23;
// A real estate job, such as Buyer's Agent.
REAL_ESTATE = 24;
// A restaurant and hospitality job, such as Restaurant Server.
RESTAURANT_AND_HOSPITALITY = 25;
// A sales and/or retail job, such Sales Associate.
SALES_AND_RETAIL = 26;
// A science and engineering job, such as Lab Technician.
SCIENCE_AND_ENGINEERING = 27;
// A social services or non-profit job, such as Case Worker.
SOCIAL_SERVICES_AND_NON_PROFIT = 28;
// A sports, fitness, or recreation job, such as Personal Trainer.
SPORTS_FITNESS_AND_RECREATION = 29;
// A transportation or logistics job, such as Truck Driver.
TRANSPORTATION_AND_LOGISTICS = 30;
}
// An enum that represents the job posting region. In most cases, job postings
// don't need to specify a region. If a region is given, jobs are
// eligible for searches in the specified region.
enum PostingRegion {
// If the region is unspecified, the job is only returned if it
// matches the [LocationFilter][google.cloud.talent.v4.LocationFilter].
POSTING_REGION_UNSPECIFIED = 0;
// In addition to exact location matching, job posting is returned when the
// [LocationFilter][google.cloud.talent.v4.LocationFilter] in the search query is in the same administrative area
// as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job
// is posted in "CA, USA", it's returned if [LocationFilter][google.cloud.talent.v4.LocationFilter] has
// "Mountain View".
//
// Administrative area refers to top-level administrative subdivision of this
// country. For example, US state, IT region, UK constituent nation and
// JP prefecture.
ADMINISTRATIVE_AREA = 1;
// In addition to exact location matching, job is returned when
// [LocationFilter][google.cloud.talent.v4.LocationFilter] in search query is in the same country as this job.
// For example, if a `NATION_WIDE` job is posted in "USA", it's
// returned if [LocationFilter][google.cloud.talent.v4.LocationFilter] has 'Mountain View'.
NATION = 2;
// Job allows employees to work remotely (telecommute).
// If locations are provided with this value, the job is
// considered as having a location, but telecommuting is allowed.
TELECOMMUTE = 3;
}
// Deprecated. All resources are only visible to the owner.
//
// An enum that represents who has view access to the resource.
enum Visibility {
option deprecated = true;
// Default value.
VISIBILITY_UNSPECIFIED = 0;
// The resource is only visible to the GCP account who owns it.
ACCOUNT_ONLY = 1;
// The resource is visible to the owner and may be visible to other
// applications and processes at Google.
SHARED_WITH_GOOGLE = 2;
// The resource is visible to the owner and may be visible to all other API
// clients.
SHARED_WITH_PUBLIC = 3;
}
// Option for HTML content sanitization on user input fields, for example, job
// description. By setting this option, user can determine whether and how
// sanitization is performed on these fields.
enum HtmlSanitization {
// Default value.
HTML_SANITIZATION_UNSPECIFIED = 0;
// Disables sanitization on HTML input.
HTML_SANITIZATION_DISABLED = 1;
// Sanitizes HTML input, only accepts bold, italic, ordered list, and
// unordered list markup tags.
SIMPLE_FORMATTING_ONLY = 2;
}
// Method for commute.
enum CommuteMethod {
// Commute method isn't specified.
COMMUTE_METHOD_UNSPECIFIED = 0;
// Commute time is calculated based on driving time.
DRIVING = 1;
// Commute time is calculated based on public transit including bus, metro,
// subway, and so on.
TRANSIT = 2;
}
// A resource that represents a location with full geographic information.
message Location {
// An enum which represents the type of a location.
enum LocationType {
// Default value if the type isn't specified.
LOCATION_TYPE_UNSPECIFIED = 0;
// A country level location.
COUNTRY = 1;
// A state or equivalent level location.
ADMINISTRATIVE_AREA = 2;
// A county or equivalent level location.
SUB_ADMINISTRATIVE_AREA = 3;
// A city or equivalent level location.
LOCALITY = 4;
// A postal code level location.
POSTAL_CODE = 5;
// A sublocality is a subdivision of a locality, for example a city borough,
// ward, or arrondissement. Sublocalities are usually recognized by a local
// political authority. For example, Manhattan and Brooklyn are recognized
// as boroughs by the City of New York, and are therefore modeled as
// sublocalities.
SUB_LOCALITY = 6;
// A district or equivalent level location.
SUB_LOCALITY_1 = 7;
// A smaller district or equivalent level display.
SUB_LOCALITY_2 = 8;
// A neighborhood level location.
NEIGHBORHOOD = 9;
// A street address level location.
STREET_ADDRESS = 10;
}
// The type of a location, which corresponds to the address lines field of
// [google.type.PostalAddress][google.type.PostalAddress]. For example, "Downtown, Atlanta, GA, USA"
// has a type of [LocationType.NEIGHBORHOOD][google.cloud.talent.v4.Location.LocationType.NEIGHBORHOOD], and "Kansas City, KS, USA"
// has a type of [LocationType.LOCALITY][google.cloud.talent.v4.Location.LocationType.LOCALITY].
LocationType location_type = 1;
// 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.
google.type.PostalAddress postal_address = 2;
// An object representing a latitude/longitude pair.
google.type.LatLng lat_lng = 3;
// Radius in miles of the job location. This value is derived from the
// location bounding box in which a circle with the specified radius
// centered from [google.type.LatLng][google.type.LatLng] covers the area associated with the
// job location.
// For example, currently, "Mountain View, CA, USA" has a radius of
// 6.17 miles.
double radius_miles = 4;
}
// Meta information related to the job searcher or entity
// conducting the job search. This information is used to improve the
// performance of the service.
message RequestMetadata {
// Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
//
// The client-defined scope or source of the service call, which typically
// is the domain on
// which the service has been implemented and is currently being run.
//
// For example, if the service is being run by client <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.
//
// Note that any improvements to the model for a particular tenant site rely
// on this field being set correctly to a unique domain.
//
// The maximum number of allowed characters is 255.
string domain = 1;
// Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
//
// A unique session identification string. A session is defined as the
// duration of an end user's interaction with the service over a certain
// period.
// Obfuscate this field for privacy concerns before
// providing it to the service.
//
// Note that any improvements to the model for a particular tenant site rely
// on this field being set correctly to a unique session ID.
//
// The maximum number of allowed characters is 255.
string session_id = 2;
// Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
//
// A unique user identification string, as determined by the client.
// To have the strongest positive impact on search quality
// make sure the client-level is unique.
// Obfuscate this field for privacy concerns before
// providing it to the service.
//
// Note that any improvements to the model for a particular tenant site rely
// on this field being set correctly to a unique user ID.
//
// The maximum number of allowed characters is 255.
string user_id = 3;
// Only set when any of [domain][google.cloud.talent.v4.RequestMetadata.domain], [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4.RequestMetadata.user_id] isn't
// available for some reason. It is highly recommended not to set this field
// and provide accurate [domain][google.cloud.talent.v4.RequestMetadata.domain], [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4.RequestMetadata.user_id] for the
// best service experience.
bool allow_missing_ids = 4;
// The type of device used by the job seeker at the time of the call to the
// service.
DeviceInfo device_info = 5;
}
// Additional information returned to client, such as debugging information.
message ResponseMetadata {
// A unique id associated with this call.
// This id is logged for tracking purposes.
string request_id = 1;
}
// 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.
message DeviceInfo {
// An enumeration describing an API access portal and exposure mechanism.
enum DeviceType {
// The device type isn't specified.
DEVICE_TYPE_UNSPECIFIED = 0;
// A desktop web browser, such as, Chrome, Firefox, Safari, or Internet
// Explorer)
WEB = 1;
// A mobile device web browser, such as a phone or tablet with a Chrome
// browser.
MOBILE_WEB = 2;
// An Android device native application.
ANDROID = 3;
// An iOS device native application.
IOS = 4;
// A bot, as opposed to a device operated by human beings, such as a web
// crawler.
BOT = 5;
// Other devices types.
OTHER = 6;
}
// Type of the device.
DeviceType device_type = 1;
// A device-specific ID. The ID must be a unique identifier that
// distinguishes the device from other devices.
string id = 2;
}
// Custom attribute values that are either filterable or non-filterable.
message CustomAttribute {
// Exactly one of [string_values][google.cloud.talent.v4.CustomAttribute.string_values] or [long_values][google.cloud.talent.v4.CustomAttribute.long_values] must be specified.
//
// This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
// `CASE_INSENSITIVE_MATCH`) search.
// For filterable `string_value`s, a maximum total number of 200 values
// is allowed, with each `string_value` has a byte size of no more than
// 500B. For unfilterable `string_values`, the maximum total byte size of
// unfilterable `string_values` is 50KB.
//
// Empty string isn't allowed.
repeated string string_values = 1;
// Exactly one of [string_values][google.cloud.talent.v4.CustomAttribute.string_values] or [long_values][google.cloud.talent.v4.CustomAttribute.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][google.cloud.talent.v4.CustomAttribute.long_values] is supported.
repeated int64 long_values = 2;
// If the `filterable` flag is true, the custom field values may be used for
// custom attribute filters [JobQuery.custom_attribute_filter][google.cloud.talent.v4.JobQuery.custom_attribute_filter].
// If false, these values may not be used for custom attribute filters.
//
// Default is false.
bool filterable = 3;
// If the `keyword_searchable` flag is true, the keywords in custom fields are
// searchable by keyword match.
// If false, the values are not searchable by keyword match.
//
// Default is false.
bool keyword_searchable = 4;
}
// Spell check result.
message SpellingCorrection {
// Indicates if the query was corrected by the spell checker.
bool corrected = 1;
// Correction output consisting of the corrected keyword string.
string corrected_text = 2;
// Corrected output with html tags to highlight the corrected words.
// Corrected words are called out with the "<b><i>...</i></b>" html tags.
//
// For example, the user input query is "software enginear", where the second
// word, "enginear," is incorrect. It should be "engineer". When spelling
// correction is enabled, this value is
// "software <b><i>engineer</i></b>".
string corrected_html = 3;
}
// Job compensation details.
message CompensationInfo {
// 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][google.cloud.talent.v4.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4.CompensationInfo.CompensationEntry.range].
// - and its [expected_units_per_year][google.cloud.talent.v4.CompensationInfo.CompensationEntry.expected_units_per_year] is set or can be derived.
// Its annualized range is determined as ([amount][google.cloud.talent.v4.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4.CompensationInfo.CompensationEntry.range]) times
// [expected_units_per_year][google.cloud.talent.v4.CompensationInfo.CompensationEntry.expected_units_per_year].
message CompensationEntry {
// Compensation type.
//
// Default is [CompensationType.COMPENSATION_TYPE_UNSPECIFIED][google.cloud.talent.v4.CompensationInfo.CompensationType.COMPENSATION_TYPE_UNSPECIFIED].
CompensationType type = 1;
// Frequency of the specified amount.
//
// Default is [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED].
CompensationUnit unit = 2;
// Compensation amount. It could be a fixed amount or a floating range.
oneof compensation_amount {
// Compensation amount.
google.type.Money amount = 3;
// Compensation range.
CompensationRange range = 4;
}
// Compensation description. For example, could
// indicate equity terms or provide additional context to an estimated
// bonus.
string description = 5;
// Expected number of units paid each year. If not specified, when
// [Job.employment_types][google.cloud.talent.v4.Job.employment_types] is FULLTIME, a default value is inferred
// based on [unit][google.cloud.talent.v4.CompensationInfo.CompensationEntry.unit]. Default values:
// - HOURLY: 2080
// - DAILY: 260
// - WEEKLY: 52
// - MONTHLY: 12
// - ANNUAL: 1
google.protobuf.DoubleValue expected_units_per_year = 6;
}
// Compensation range.
message CompensationRange {
// The maximum amount of compensation. If left empty, the value is set
// to a maximal compensation value and the currency code is set to
// match the [currency code][google.type.Money.currency_code] of
// min_compensation.
google.type.Money max_compensation = 2;
// 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][google.type.Money.currency_code] of max_compensation.
google.type.Money min_compensation = 1;
}
// The type of compensation.
//
// For compensation amounts specified in non-monetary amounts,
// describe the compensation scheme in the [CompensationEntry.description][google.cloud.talent.v4.CompensationInfo.CompensationEntry.description].
//
// For example, tipping format is described in
// [CompensationEntry.description][google.cloud.talent.v4.CompensationInfo.CompensationEntry.description] (for example, "expect 15-20% tips based
// on customer bill.") and an estimate of the tips provided in
// [CompensationEntry.amount][google.cloud.talent.v4.CompensationInfo.CompensationEntry.amount] or [CompensationEntry.range][google.cloud.talent.v4.CompensationInfo.CompensationEntry.range] ($10 per hour).
//
// For example, equity is described in [CompensationEntry.description][google.cloud.talent.v4.CompensationInfo.CompensationEntry.description]
// (for example, "1% - 2% equity vesting over 4 years, 1 year cliff") and
// value estimated in [CompensationEntry.amount][google.cloud.talent.v4.CompensationInfo.CompensationEntry.amount] or
// [CompensationEntry.range][google.cloud.talent.v4.CompensationInfo.CompensationEntry.range]. If no value estimate is possible, units are
// [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED] and then further
// clarified in [CompensationEntry.description][google.cloud.talent.v4.CompensationInfo.CompensationEntry.description] field.
enum CompensationType {
// Default value.
COMPENSATION_TYPE_UNSPECIFIED = 0;
// Base compensation: Refers to the fixed amount of money paid to an
// employee by an employer in return for work performed. Base compensation
// does not include benefits, bonuses or any other potential compensation
// from an employer.
BASE = 1;
// Bonus.
BONUS = 2;
// Signing bonus.
SIGNING_BONUS = 3;
// Equity.
EQUITY = 4;
// Profit sharing.
PROFIT_SHARING = 5;
// Commission.
COMMISSIONS = 6;
// Tips.
TIPS = 7;
// Other compensation type.
OTHER_COMPENSATION_TYPE = 8;
}
// Pay frequency.
enum CompensationUnit {
// Default value.
COMPENSATION_UNIT_UNSPECIFIED = 0;
// Hourly.
HOURLY = 1;
// Daily.
DAILY = 2;
// Weekly
WEEKLY = 3;
// Monthly.
MONTHLY = 4;
// Yearly.
YEARLY = 5;
// One time.
ONE_TIME = 6;
// Other compensation units.
OTHER_COMPENSATION_UNIT = 7;
}
// Job compensation information.
//
// At most one entry can be of type
// [CompensationInfo.CompensationType.BASE][google.cloud.talent.v4.CompensationInfo.CompensationType.BASE], which is
// referred as **base compensation entry** for the job.
repeated CompensationEntry entries = 1;
// Output only. Annualized base compensation range. Computed as base compensation entry's
// [CompensationEntry.amount][google.cloud.talent.v4.CompensationInfo.CompensationEntry.amount] times
// [CompensationEntry.expected_units_per_year][google.cloud.talent.v4.CompensationInfo.CompensationEntry.expected_units_per_year].
//
// See [CompensationEntry][google.cloud.talent.v4.CompensationInfo.CompensationEntry] for explanation on compensation annualization.
CompensationRange annualized_base_compensation_range = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Annualized total compensation range. Computed as all compensation entries'
// [CompensationEntry.amount][google.cloud.talent.v4.CompensationInfo.CompensationEntry.amount] times
// [CompensationEntry.expected_units_per_year][google.cloud.talent.v4.CompensationInfo.CompensationEntry.expected_units_per_year].
//
// See [CompensationEntry][google.cloud.talent.v4.CompensationInfo.CompensationEntry] for explanation on compensation annualization.
CompensationRange annualized_total_compensation_range = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Metadata used for long running operations returned by CTS batch APIs.
// It's used to replace [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata].
message BatchOperationMetadata {
enum State {
// Default value.
STATE_UNSPECIFIED = 0;
// The batch operation is being prepared for processing.
INITIALIZING = 1;
// The batch operation is actively being processed.
PROCESSING = 2;
// The batch operation is processed, and at least one item has been
// successfully processed.
SUCCEEDED = 3;
// The batch operation is done and no item has been successfully processed.
FAILED = 4;
// The batch operation is in the process of cancelling after
// [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] is called.
CANCELLING = 5;
// The batch operation is done after
// [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] is called. Any items
// processed before cancelling are returned in the response.
CANCELLED = 6;
}
// The state of a long running operation.
State state = 1;
// More detailed information about operation state.
string state_description = 2;
// Count of successful item(s) inside an operation.
int32 success_count = 3;
// Count of failed item(s) inside an operation.
int32 failure_count = 4;
// Count of total item(s) inside an operation.
int32 total_count = 5;
// The time when the batch operation is created.
google.protobuf.Timestamp create_time = 6;
// The time when the batch operation status is updated. The metadata and the
// [update_time][google.cloud.talent.v4.BatchOperationMetadata.update_time] is refreshed every minute otherwise cached data is
// returned.
google.protobuf.Timestamp update_time = 7;
// The time when the batch operation is finished and
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to `true`.
google.protobuf.Timestamp end_time = 8;
}