google-cloud-talent 0.8.1 → 0.20.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -59
  4. data/LICENSE.md +203 -0
  5. data/MIGRATING.md +347 -0
  6. data/README.md +35 -25
  7. data/lib/{google/cloud/talent/v4beta1/doc/google/protobuf/empty.rb → google-cloud-talent.rb} +5 -15
  8. data/lib/google/cloud/talent.rb +254 -442
  9. data/lib/google/cloud/talent/version.rb +6 -2
  10. metadata +62 -111
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/talent/v4beta1.rb +0 -543
  13. data/lib/google/cloud/talent/v4beta1/application_pb.rb +0 -62
  14. data/lib/google/cloud/talent/v4beta1/application_service_client.rb +0 -491
  15. data/lib/google/cloud/talent/v4beta1/application_service_client_config.json +0 -51
  16. data/lib/google/cloud/talent/v4beta1/application_service_pb.rb +0 -54
  17. data/lib/google/cloud/talent/v4beta1/application_service_services_pb.rb +0 -56
  18. data/lib/google/cloud/talent/v4beta1/batch_pb.rb +0 -18
  19. data/lib/google/cloud/talent/v4beta1/common_pb.rb +0 -341
  20. data/lib/google/cloud/talent/v4beta1/company_pb.rb +0 -40
  21. data/lib/google/cloud/talent/v4beta1/company_service_client.rb +0 -535
  22. data/lib/google/cloud/talent/v4beta1/company_service_client_config.json +0 -51
  23. data/lib/google/cloud/talent/v4beta1/company_service_pb.rb +0 -55
  24. data/lib/google/cloud/talent/v4beta1/company_service_services_pb.rb +0 -56
  25. data/lib/google/cloud/talent/v4beta1/completion_client.rb +0 -359
  26. data/lib/google/cloud/talent/v4beta1/completion_client_config.json +0 -31
  27. data/lib/google/cloud/talent/v4beta1/completion_service_pb.rb +0 -55
  28. data/lib/google/cloud/talent/v4beta1/completion_service_services_pb.rb +0 -48
  29. data/lib/google/cloud/talent/v4beta1/credentials.rb +0 -42
  30. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application.rb +0 -166
  31. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application_service.rb +0 -107
  32. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb +0 -1147
  33. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company.rb +0 -110
  34. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company_service.rb +0 -122
  35. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb +0 -141
  36. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb +0 -238
  37. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event_service.rb +0 -36
  38. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb +0 -847
  39. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/histogram.rb +0 -55
  40. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb +0 -363
  41. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb +0 -762
  42. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb +0 -808
  43. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb +0 -446
  44. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant.rb +0 -74
  45. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant_service.rb +0 -101
  46. data/lib/google/cloud/talent/v4beta1/doc/google/longrunning/operations.rb +0 -51
  47. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/any.rb +0 -131
  48. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/duration.rb +0 -91
  49. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/field_mask.rb +0 -222
  50. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/timestamp.rb +0 -113
  51. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/wrappers.rb +0 -34
  52. data/lib/google/cloud/talent/v4beta1/doc/google/rpc/status.rb +0 -87
  53. data/lib/google/cloud/talent/v4beta1/doc/google/type/date.rb +0 -43
  54. data/lib/google/cloud/talent/v4beta1/doc/google/type/latlng.rb +0 -31
  55. data/lib/google/cloud/talent/v4beta1/doc/google/type/money.rb +0 -36
  56. data/lib/google/cloud/talent/v4beta1/doc/google/type/postal_address.rb +0 -126
  57. data/lib/google/cloud/talent/v4beta1/doc/google/type/timeofday.rb +0 -37
  58. data/lib/google/cloud/talent/v4beta1/event_pb.rb +0 -69
  59. data/lib/google/cloud/talent/v4beta1/event_service_client.rb +0 -268
  60. data/lib/google/cloud/talent/v4beta1/event_service_client_config.json +0 -31
  61. data/lib/google/cloud/talent/v4beta1/event_service_pb.rb +0 -26
  62. data/lib/google/cloud/talent/v4beta1/event_service_services_pb.rb +0 -53
  63. data/lib/google/cloud/talent/v4beta1/filters_pb.rb +0 -187
  64. data/lib/google/cloud/talent/v4beta1/helpers.rb +0 -162
  65. data/lib/google/cloud/talent/v4beta1/histogram_pb.rb +0 -27
  66. data/lib/google/cloud/talent/v4beta1/job_pb.rb +0 -71
  67. data/lib/google/cloud/talent/v4beta1/job_service_client.rb +0 -1576
  68. data/lib/google/cloud/talent/v4beta1/job_service_client_config.json +0 -76
  69. data/lib/google/cloud/talent/v4beta1/job_service_pb.rb +0 -165
  70. data/lib/google/cloud/talent/v4beta1/job_service_services_pb.rb +0 -92
  71. data/lib/google/cloud/talent/v4beta1/profile_pb.rb +0 -212
  72. data/lib/google/cloud/talent/v4beta1/profile_service_client.rb +0 -844
  73. data/lib/google/cloud/talent/v4beta1/profile_service_client_config.json +0 -56
  74. data/lib/google/cloud/talent/v4beta1/profile_service_pb.rb +0 -88
  75. data/lib/google/cloud/talent/v4beta1/profile_service_services_pb.rb +0 -67
  76. data/lib/google/cloud/talent/v4beta1/tenant_pb.rb +0 -33
  77. data/lib/google/cloud/talent/v4beta1/tenant_service_client.rb +0 -476
  78. data/lib/google/cloud/talent/v4beta1/tenant_service_client_config.json +0 -51
  79. data/lib/google/cloud/talent/v4beta1/tenant_service_pb.rb +0 -54
  80. data/lib/google/cloud/talent/v4beta1/tenant_service_services_pb.rb +0 -55
@@ -1,55 +0,0 @@
1
- # Copyright 2019 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # The histogram request.
21
- # @!attribute [rw] histogram_query
22
- # @return [String]
23
- # An expression specifies a histogram request against matching resources
24
- # (for example, jobs, profiles) for searches.
25
- #
26
- # See
27
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#histogram_queries SearchJobsRequest#histogram_queries}
28
- # and
29
- # {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#histogram_queries SearchProfilesRequest#histogram_queries}
30
- # for details about syntax.
31
- class HistogramQuery; end
32
-
33
- # Histogram result that matches
34
- # {Google::Cloud::Talent::V4beta1::HistogramQuery HistogramQuery} specified in
35
- # searches.
36
- # @!attribute [rw] histogram_query
37
- # @return [String]
38
- # Requested histogram expression.
39
- # @!attribute [rw] histogram
40
- # @return [Hash{String => Integer}]
41
- # A map from the values of the facet associated with distinct values to the
42
- # number of matching entries with corresponding value.
43
- #
44
- # The key format is:
45
- #
46
- # * (for string histogram) string values stored in the field.
47
- # * (for named numeric bucket) name specified in `bucket()` function, like
48
- # for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`.
49
- # * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for
50
- # example, `0-1000`, `MIN-0`, and `0-MAX`.
51
- class HistogramQueryResult; end
52
- end
53
- end
54
- end
55
- end
@@ -1,363 +0,0 @@
1
- # Copyright 2019 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # A Job resource represents a job posting (also referred to as a "job listing"
21
- # or "job requisition"). A job belongs to a
22
- # {Google::Cloud::Talent::V4beta1::Company Company}, which is the hiring entity
23
- # responsible for the job.
24
- # @!attribute [rw] name
25
- # @return [String]
26
- # Required during job update.
27
- #
28
- # The resource name for the job. This is generated by the service when a
29
- # job is created.
30
- #
31
- # The format is
32
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For
33
- # example, "projects/foo/tenants/bar/jobs/baz".
34
- #
35
- # If tenant id is unspecified, the default tenant is used. For
36
- # example, "projects/foo/jobs/bar".
37
- #
38
- # Use of this field in job queries and API calls is preferred over the use of
39
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id} since this
40
- # value is unique.
41
- # @!attribute [rw] company
42
- # @return [String]
43
- # Required. The resource name of the company listing the job.
44
- #
45
- # The format is
46
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For
47
- # example, "projects/foo/tenants/bar/companies/baz".
48
- #
49
- # If tenant id is unspecified, the default tenant is used. For
50
- # example, "projects/foo/companies/bar".
51
- # @!attribute [rw] requisition_id
52
- # @return [String]
53
- # Required. The requisition ID, also referred to as the posting ID, is
54
- # assigned by the client to identify a job. This field is intended to be used
55
- # by clients for client identification and tracking of postings. A job isn't
56
- # allowed to be created if there is another job with the same
57
- # {Google::Cloud::Talent::V4beta1::Job#name company},
58
- # {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and
59
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}.
60
- #
61
- # The maximum number of allowed characters is 255.
62
- # @!attribute [rw] title
63
- # @return [String]
64
- # Required. The title of the job, such as "Software Engineer"
65
- #
66
- # The maximum number of allowed characters is 500.
67
- # @!attribute [rw] description
68
- # @return [String]
69
- # Required. The description of the job, which typically includes a
70
- # multi-paragraph description of the company and related information.
71
- # Separate fields are provided on the job object for
72
- # {Google::Cloud::Talent::V4beta1::Job#responsibilities responsibilities},
73
- # {Google::Cloud::Talent::V4beta1::Job#qualifications qualifications}, and other
74
- # job characteristics. Use of these separate job fields is recommended.
75
- #
76
- # This field accepts and sanitizes HTML input, and also accepts
77
- # bold, italic, ordered list, and unordered list markup tags.
78
- #
79
- # The maximum number of allowed characters is 100,000.
80
- # @!attribute [rw] addresses
81
- # @return [Array<String>]
82
- # Strongly recommended for the best service experience.
83
- #
84
- # Location(s) where the employer is looking to hire for this job posting.
85
- #
86
- # Specifying the full street address(es) of the hiring location enables
87
- # better API results, especially job searches by commute time.
88
- #
89
- # At most 50 locations are allowed for best search performance. If a job has
90
- # more locations, it is suggested to split it into multiple jobs with unique
91
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}s (e.g.
92
- # 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the
93
- # same {Google::Cloud::Talent::V4beta1::Job#company company},
94
- # {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and
95
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id} are not
96
- # allowed. If the original
97
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id} must be
98
- # preserved, a custom field should be used for storage. It is also suggested
99
- # to group the locations that close to each other in the same job for better
100
- # search experience.
101
- #
102
- # The maximum number of allowed characters is 500.
103
- # @!attribute [rw] application_info
104
- # @return [Google::Cloud::Talent::V4beta1::Job::ApplicationInfo]
105
- # Job application information.
106
- # @!attribute [rw] job_benefits
107
- # @return [Array<Google::Cloud::Talent::V4beta1::JobBenefit>]
108
- # The benefits included with the job.
109
- # @!attribute [rw] compensation_info
110
- # @return [Google::Cloud::Talent::V4beta1::CompensationInfo]
111
- # Job compensation information (a.k.a. "pay rate") i.e., the compensation
112
- # that will paid to the employee.
113
- # @!attribute [rw] custom_attributes
114
- # @return [Hash{String => Google::Cloud::Talent::V4beta1::CustomAttribute}]
115
- # A map of fields to hold both filterable and non-filterable custom job
116
- # attributes that are not covered by the provided structured fields.
117
- #
118
- # The keys of the map are strings up to 64 bytes and must match the
119
- # pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or
120
- # KEY_1_LIKE_THIS.
121
- #
122
- # At most 100 filterable and at most 100 unfilterable keys are supported.
123
- # For filterable `string_values`, across all keys at most 200 values are
124
- # allowed, with each string no more than 255 characters. For unfilterable
125
- # `string_values`, the maximum total size of `string_values` across all keys
126
- # is 50KB.
127
- # @!attribute [rw] degree_types
128
- # @return [Array<Google::Cloud::Talent::V4beta1::DegreeType>]
129
- # The desired education degrees for the job, such as Bachelors, Masters.
130
- # @!attribute [rw] department
131
- # @return [String]
132
- # The department or functional area within the company with the open
133
- # position.
134
- #
135
- # The maximum number of allowed characters is 255.
136
- # @!attribute [rw] employment_types
137
- # @return [Array<Google::Cloud::Talent::V4beta1::EmploymentType>]
138
- # The employment type(s) of a job, for example,
139
- # {Google::Cloud::Talent::V4beta1::EmploymentType::FULL_TIME full time} or
140
- # {Google::Cloud::Talent::V4beta1::EmploymentType::PART_TIME part time}.
141
- # @!attribute [rw] incentives
142
- # @return [String]
143
- # A description of bonus, commission, and other compensation
144
- # incentives associated with the job not including salary or pay.
145
- #
146
- # The maximum number of allowed characters is 10,000.
147
- # @!attribute [rw] language_code
148
- # @return [String]
149
- # The language of the posting. This field is distinct from
150
- # any requirements for fluency that are associated with the job.
151
- #
152
- # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
153
- # For more information, see
154
- # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
155
- # class="external" target="_blank" }.
156
- #
157
- # If this field is unspecified and
158
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description} is present,
159
- # detected language code based on
160
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description} is assigned,
161
- # otherwise defaults to 'en_US'.
162
- # @!attribute [rw] job_level
163
- # @return [Google::Cloud::Talent::V4beta1::JobLevel]
164
- # The experience level associated with the job, such as "Entry Level".
165
- # @!attribute [rw] promotion_value
166
- # @return [Integer]
167
- # A promotion value of the job, as determined by the client.
168
- # The value determines the sort order of the jobs returned when searching for
169
- # jobs using the featured jobs search call, with higher promotional values
170
- # being returned first and ties being resolved by relevance sort. Only the
171
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
172
- #
173
- # Default value is 0, and negative values are treated as 0.
174
- # @!attribute [rw] qualifications
175
- # @return [String]
176
- # A description of the qualifications required to perform the
177
- # job. The use of this field is recommended
178
- # as an alternative to using the more general
179
- # {Google::Cloud::Talent::V4beta1::Job#description description} field.
180
- #
181
- # This field accepts and sanitizes HTML input, and also accepts
182
- # bold, italic, ordered list, and unordered list markup tags.
183
- #
184
- # The maximum number of allowed characters is 10,000.
185
- # @!attribute [rw] responsibilities
186
- # @return [String]
187
- # A description of job responsibilities. The use of this field is
188
- # recommended as an alternative to using the more general
189
- # {Google::Cloud::Talent::V4beta1::Job#description description} field.
190
- #
191
- # This field accepts and sanitizes HTML input, and also accepts
192
- # bold, italic, ordered list, and unordered list markup tags.
193
- #
194
- # The maximum number of allowed characters is 10,000.
195
- # @!attribute [rw] posting_region
196
- # @return [Google::Cloud::Talent::V4beta1::PostingRegion]
197
- # The job {Google::Cloud::Talent::V4beta1::PostingRegion PostingRegion} (for
198
- # example, state, country) throughout which the job is available. If this
199
- # field is set, a
200
- # {Google::Cloud::Talent::V4beta1::LocationFilter LocationFilter} in a search
201
- # query within the job region finds this job posting if an exact location
202
- # match isn't specified. If this field is set to
203
- # {Google::Cloud::Talent::V4beta1::PostingRegion::NATION PostingRegion::NATION} or
204
- # {Google::Cloud::Talent::V4beta1::PostingRegion::ADMINISTRATIVE_AREA PostingRegion::ADMINISTRATIVE_AREA},
205
- # setting job {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses} to
206
- # the same location level as this field is strongly recommended.
207
- # @!attribute [rw] visibility
208
- # @return [Google::Cloud::Talent::V4beta1::Visibility]
209
- # Deprecated. The job is only visible to the owner.
210
- #
211
- # The visibility of the job.
212
- #
213
- # Defaults to
214
- # {Google::Cloud::Talent::V4beta1::Visibility::ACCOUNT_ONLY Visibility::ACCOUNT_ONLY}
215
- # if not specified.
216
- # @!attribute [rw] job_start_time
217
- # @return [Google::Protobuf::Timestamp]
218
- # The start timestamp of the job in UTC time zone. Typically this field
219
- # is used for contracting engagements. Invalid timestamps are ignored.
220
- # @!attribute [rw] job_end_time
221
- # @return [Google::Protobuf::Timestamp]
222
- # The end timestamp of the job. Typically this field is used for contracting
223
- # engagements. Invalid timestamps are ignored.
224
- # @!attribute [rw] posting_publish_time
225
- # @return [Google::Protobuf::Timestamp]
226
- # The timestamp this job posting was most recently published. The default
227
- # value is the time the request arrives at the server. Invalid timestamps are
228
- # ignored.
229
- # @!attribute [rw] posting_expire_time
230
- # @return [Google::Protobuf::Timestamp]
231
- # Strongly recommended for the best service experience.
232
- #
233
- # The expiration timestamp of the job. After this timestamp, the
234
- # job is marked as expired, and it no longer appears in search results. The
235
- # expired job can't be listed by the
236
- # {Google::Cloud::Talent::V4beta1::JobService::ListJobs ListJobs} API, but it can
237
- # be retrieved with the
238
- # {Google::Cloud::Talent::V4beta1::JobService::GetJob GetJob} API or updated with
239
- # the {Google::Cloud::Talent::V4beta1::JobService::UpdateJob UpdateJob} API or
240
- # deleted with the
241
- # {Google::Cloud::Talent::V4beta1::JobService::DeleteJob DeleteJob} API. An
242
- # expired job can be updated and opened again by using a future expiration
243
- # timestamp. Updating an expired job fails if there is another existing open
244
- # job with same {Google::Cloud::Talent::V4beta1::Job#company company},
245
- # {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and
246
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}.
247
- #
248
- # The expired jobs are retained in our system for 90 days. However, the
249
- # overall expired job count cannot exceed 3 times the maximum number of
250
- # open jobs over previous 7 days. If this threshold is exceeded,
251
- # expired jobs are cleaned out in order of earliest expire time.
252
- # Expired jobs are no longer accessible after they are cleaned
253
- # out.
254
- #
255
- # Invalid timestamps are ignored, and treated as expire time not provided.
256
- #
257
- # If the timestamp is before the instant request is made, the job
258
- # is treated as expired immediately on creation. This kind of job can
259
- # not be updated. And when creating a job with past timestamp, the
260
- # {Google::Cloud::Talent::V4beta1::Job#posting_publish_time posting_publish_time}
261
- # must be set before
262
- # {Google::Cloud::Talent::V4beta1::Job#posting_expire_time posting_expire_time}.
263
- # The purpose of this feature is to allow other objects, such as
264
- # {Google::Cloud::Talent::V4beta1::Application Application}, to refer a job that
265
- # didn't exist in the system prior to becoming expired. If you want to modify
266
- # a job that was expired on creation, delete it and create a new one.
267
- #
268
- # If this value isn't provided at the time of job creation or is invalid,
269
- # the job posting expires after 30 days from the job's creation time. For
270
- # example, if the job was created on 2017/01/01 13:00AM UTC with an
271
- # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
272
- #
273
- # If this value isn't provided on job update, it depends on the field masks
274
- # set by
275
- # {Google::Cloud::Talent::V4beta1::UpdateJobRequest#update_mask UpdateJobRequest#update_mask}.
276
- # If the field masks include
277
- # {Google::Cloud::Talent::V4beta1::Job#job_end_time job_end_time}, or the masks
278
- # are empty meaning that every field is updated, the job posting expires
279
- # after 30 days from the job's last update time. Otherwise the expiration
280
- # date isn't updated.
281
- # @!attribute [rw] posting_create_time
282
- # @return [Google::Protobuf::Timestamp]
283
- # Output only. The timestamp when this job posting was created.
284
- # @!attribute [rw] posting_update_time
285
- # @return [Google::Protobuf::Timestamp]
286
- # Output only. The timestamp when this job posting was last updated.
287
- # @!attribute [rw] company_display_name
288
- # @return [String]
289
- # Output only. Display name of the company listing the job.
290
- # @!attribute [rw] derived_info
291
- # @return [Google::Cloud::Talent::V4beta1::Job::DerivedInfo]
292
- # Output only. Derived details about the job posting.
293
- # @!attribute [rw] processing_options
294
- # @return [Google::Cloud::Talent::V4beta1::Job::ProcessingOptions]
295
- # Options for job processing.
296
- class Job
297
- # Application related details of a job posting.
298
- # @!attribute [rw] emails
299
- # @return [Array<String>]
300
- # Use this field to specify email address(es) to which resumes or
301
- # applications can be sent.
302
- #
303
- # The maximum number of allowed characters for each entry is 255.
304
- # @!attribute [rw] instruction
305
- # @return [String]
306
- # Use this field to provide instructions, such as "Mail your application
307
- # to ...", that a candidate can follow to apply for the job.
308
- #
309
- # This field accepts and sanitizes HTML input, and also accepts
310
- # bold, italic, ordered list, and unordered list markup tags.
311
- #
312
- # The maximum number of allowed characters is 3,000.
313
- # @!attribute [rw] uris
314
- # @return [Array<String>]
315
- # Use this URI field to direct an applicant to a website, for example to
316
- # link to an online application form.
317
- #
318
- # The maximum number of allowed characters for each entry is 2,000.
319
- class ApplicationInfo; end
320
-
321
- # Derived details about the job posting.
322
- # @!attribute [rw] locations
323
- # @return [Array<Google::Cloud::Talent::V4beta1::Location>]
324
- # Structured locations of the job, resolved from
325
- # {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses}.
326
- #
327
- # {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations locations} are
328
- # exactly matched to
329
- # {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses} in the same
330
- # order.
331
- # @!attribute [rw] job_categories
332
- # @return [Array<Google::Cloud::Talent::V4beta1::JobCategory>]
333
- # Job categories derived from
334
- # {Google::Cloud::Talent::V4beta1::Job#title Job#title} and
335
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description}.
336
- class DerivedInfo; end
337
-
338
- # Options for job processing.
339
- # @!attribute [rw] disable_street_address_resolution
340
- # @return [true, false]
341
- # If set to `true`, the service does not attempt to resolve a
342
- # more precise address for the job.
343
- # @!attribute [rw] html_sanitization
344
- # @return [Google::Cloud::Talent::V4beta1::HtmlSanitization]
345
- # Option for job HTML content sanitization. Applied fields are:
346
- #
347
- # * description
348
- # * applicationInfo.instruction
349
- # * incentives
350
- # * qualifications
351
- # * responsibilities
352
- #
353
- # HTML tags in these fields may be stripped if sanitiazation isn't
354
- # disabled.
355
- #
356
- # Defaults to
357
- # {Google::Cloud::Talent::V4beta1::HtmlSanitization::SIMPLE_FORMATTING_ONLY HtmlSanitization::SIMPLE_FORMATTING_ONLY}.
358
- class ProcessingOptions; end
359
- end
360
- end
361
- end
362
- end
363
- end
@@ -1,762 +0,0 @@
1
- # Copyright 2019 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # Create job request.
21
- # @!attribute [rw] parent
22
- # @return [String]
23
- # Required. The resource name of the tenant under which the job is created.
24
- #
25
- # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
26
- # "projects/foo/tenant/bar". If tenant id is unspecified a default tenant
27
- # is created. For example, "projects/foo".
28
- # @!attribute [rw] job
29
- # @return [Google::Cloud::Talent::V4beta1::Job]
30
- # Required. The Job to be created.
31
- class CreateJobRequest; end
32
-
33
- # Get job request.
34
- # @!attribute [rw] name
35
- # @return [String]
36
- # Required. The resource name of the job to retrieve.
37
- #
38
- # The format is
39
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For
40
- # example, "projects/foo/tenants/bar/jobs/baz".
41
- #
42
- # If tenant id is unspecified, the default tenant is used. For
43
- # example, "projects/foo/jobs/bar".
44
- class GetJobRequest; end
45
-
46
- # Update job request.
47
- # @!attribute [rw] job
48
- # @return [Google::Cloud::Talent::V4beta1::Job]
49
- # Required. The Job to be updated.
50
- # @!attribute [rw] update_mask
51
- # @return [Google::Protobuf::FieldMask]
52
- # Strongly recommended for the best service experience.
53
- #
54
- # If {Google::Cloud::Talent::V4beta1::UpdateJobRequest#update_mask update_mask}
55
- # is provided, only the specified fields in
56
- # {Google::Cloud::Talent::V4beta1::UpdateJobRequest#job job} are updated.
57
- # Otherwise all the fields are updated.
58
- #
59
- # A field mask to restrict the fields that are updated. Only
60
- # top level fields of {Google::Cloud::Talent::V4beta1::Job Job} are supported.
61
- class UpdateJobRequest; end
62
-
63
- # Delete job request.
64
- # @!attribute [rw] name
65
- # @return [String]
66
- # Required. The resource name of the job to be deleted.
67
- #
68
- # The format is
69
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For
70
- # example, "projects/foo/tenants/bar/jobs/baz".
71
- #
72
- # If tenant id is unspecified, the default tenant is used. For
73
- # example, "projects/foo/jobs/bar".
74
- class DeleteJobRequest; end
75
-
76
- # Batch delete jobs request.
77
- # @!attribute [rw] parent
78
- # @return [String]
79
- # Required. The resource name of the tenant under which the job is created.
80
- #
81
- # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
82
- # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
83
- # is created. For example, "projects/foo".
84
- # @!attribute [rw] filter
85
- # @return [String]
86
- # Required. The filter string specifies the jobs to be deleted.
87
- #
88
- # Supported operator: =, AND
89
- #
90
- # The fields eligible for filtering are:
91
- #
92
- # * `companyName` (Required)
93
- # * `requisitionId` (Required)
94
- #
95
- # Sample Query: companyName = "projects/foo/companies/bar" AND
96
- # requisitionId = "req-1"
97
- class BatchDeleteJobsRequest; end
98
-
99
- # List jobs request.
100
- # @!attribute [rw] parent
101
- # @return [String]
102
- # Required. The resource name of the tenant under which the job is created.
103
- #
104
- # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
105
- # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
106
- # is created. For example, "projects/foo".
107
- # @!attribute [rw] filter
108
- # @return [String]
109
- # Required. The filter string specifies the jobs to be enumerated.
110
- #
111
- # Supported operator: =, AND
112
- #
113
- # The fields eligible for filtering are:
114
- #
115
- # * `companyName` (Required)
116
- # * `requisitionId`
117
- # * `status` Available values: OPEN, EXPIRED, ALL. Defaults to
118
- # OPEN if no value is specified.
119
- #
120
- # Sample Query:
121
- #
122
- # * companyName = "projects/foo/tenants/bar/companies/baz"
123
- # * companyName = "projects/foo/tenants/bar/companies/baz" AND
124
- # requisitionId = "req-1"
125
- # * companyName = "projects/foo/tenants/bar/companies/baz" AND
126
- # status = "EXPIRED"
127
- # @!attribute [rw] page_token
128
- # @return [String]
129
- # The starting point of a query result.
130
- # @!attribute [rw] page_size
131
- # @return [Integer]
132
- # The maximum number of jobs to be returned per page of results.
133
- #
134
- # If {Google::Cloud::Talent::V4beta1::ListJobsRequest#job_view job_view} is set
135
- # to
136
- # {Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_ID_ONLY JobView::JOB_VIEW_ID_ONLY},
137
- # the maximum allowed page size is 1000. Otherwise, the maximum allowed page
138
- # size is 100.
139
- #
140
- # Default is 100 if empty or a number < 1 is specified.
141
- # @!attribute [rw] job_view
142
- # @return [Google::Cloud::Talent::V4beta1::JobView]
143
- # The desired job attributes returned for jobs in the
144
- # search response. Defaults to
145
- # {Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_FULL JobView::JOB_VIEW_FULL}
146
- # if no value is specified.
147
- class ListJobsRequest; end
148
-
149
- # List jobs response.
150
- # @!attribute [rw] jobs
151
- # @return [Array<Google::Cloud::Talent::V4beta1::Job>]
152
- # The Jobs for a given company.
153
- #
154
- # The maximum number of items returned is based on the limit field
155
- # provided in the request.
156
- # @!attribute [rw] next_page_token
157
- # @return [String]
158
- # A token to retrieve the next page of results.
159
- # @!attribute [rw] metadata
160
- # @return [Google::Cloud::Talent::V4beta1::ResponseMetadata]
161
- # Additional information for the API invocation, such as the request
162
- # tracking id.
163
- class ListJobsResponse; end
164
-
165
- # The Request body of the `SearchJobs` call.
166
- # @!attribute [rw] parent
167
- # @return [String]
168
- # Required. The resource name of the tenant to search within.
169
- #
170
- # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
171
- # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
172
- # is created. For example, "projects/foo".
173
- # @!attribute [rw] search_mode
174
- # @return [Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode]
175
- # Mode of a search.
176
- #
177
- # Defaults to
178
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode::JOB_SEARCH}.
179
- # @!attribute [rw] request_metadata
180
- # @return [Google::Cloud::Talent::V4beta1::RequestMetadata]
181
- # Required. The meta information collected about the job searcher, used to
182
- # improve the search quality of the service. The identifiers (such as
183
- # `user_id`) are provided by users, and must be unique and consistent.
184
- # @!attribute [rw] job_query
185
- # @return [Google::Cloud::Talent::V4beta1::JobQuery]
186
- # Query used to search against jobs, such as keyword, location filters, etc.
187
- # @!attribute [rw] enable_broadening
188
- # @return [true, false]
189
- # Controls whether to broaden the search when it produces sparse results.
190
- # Broadened queries append results to the end of the matching results
191
- # list.
192
- #
193
- # Defaults to false.
194
- # @!attribute [rw] require_precise_result_size
195
- # @return [true, false]
196
- # Controls if the search job request requires the return of a precise
197
- # count of the first 300 results. Setting this to `true` ensures
198
- # consistency in the number of results per page. Best practice is to set this
199
- # value to true if a client allows users to jump directly to a
200
- # non-sequential search results page.
201
- #
202
- # Enabling this flag may adversely impact performance.
203
- #
204
- # Defaults to false.
205
- # @!attribute [rw] histogram_queries
206
- # @return [Array<Google::Cloud::Talent::V4beta1::HistogramQuery>]
207
- # An expression specifies a histogram request against matching jobs.
208
- #
209
- # Expression syntax is an aggregation function call with histogram facets and
210
- # other options.
211
- #
212
- # Available aggregation function calls are:
213
- # * `count(string_histogram_facet)`: Count the number of matching entities,
214
- # for each distinct attribute value.
215
- # * `count(numeric_histogram_facet, list of buckets)`: Count the number of
216
- # matching entities within each bucket.
217
- #
218
- # Data types:
219
- #
220
- # * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+.
221
- # * String: string like "any string with backslash escape for quote(\")."
222
- # * Number: whole number and floating point number like 10, -1 and -0.01.
223
- # * List: list of elements with comma(,) separator surrounded by square
224
- # brackets, for example, [1, 2, 3] and ["one", "two", "three"].
225
- #
226
- # Built-in constants:
227
- #
228
- # * MIN (minimum number similar to java Double.MIN_VALUE)
229
- # * MAX (maximum number similar to java Double.MAX_VALUE)
230
- #
231
- # Built-in functions:
232
- #
233
- # * bucket(start, end[, label]): bucket built-in function creates a bucket
234
- # with range of [start, end). Note that the end is exclusive, for example,
235
- # bucket(1, MAX, "positive number") or bucket(1, 10).
236
- #
237
- # Job histogram facets:
238
- #
239
- # * company_display_name: histogram by
240
- # {Google::Cloud::Talent::V4beta1::Job#company_display_name Job#company_display_name}.
241
- # * employment_type: histogram by
242
- # {Google::Cloud::Talent::V4beta1::Job#employment_types Job#employment_types},
243
- # for example,
244
- # "FULL_TIME", "PART_TIME".
245
- # * company_size: histogram by
246
- # {Google::Cloud::Talent::V4beta1::CompanySize CompanySize}, for example,
247
- # "SMALL", "MEDIUM", "BIG".
248
- # * publish_time_in_month: histogram by the
249
- # {Google::Cloud::Talent::V4beta1::Job#posting_publish_time Job#posting_publish_time}
250
- # in months.
251
- # Must specify list of numeric buckets in spec.
252
- # * publish_time_in_year: histogram by the
253
- # {Google::Cloud::Talent::V4beta1::Job#posting_publish_time Job#posting_publish_time}
254
- # in years.
255
- # Must specify list of numeric buckets in spec.
256
- # * degree_types: histogram by the
257
- # {Google::Cloud::Talent::V4beta1::Job#degree_types Job#degree_types}, for
258
- # example,
259
- # "Bachelors", "Masters".
260
- # * job_level: histogram by the
261
- # {Google::Cloud::Talent::V4beta1::Job#job_level Job#job_level}, for example,
262
- # "Entry
263
- # Level".
264
- # * country: histogram by the country code of jobs, for example, "US", "FR".
265
- # * admin1: histogram by the admin1 code of jobs, which is a global
266
- # placeholder referring to the state, province, or the particular term a
267
- # country uses to define the geographic structure below the country level,
268
- # for example, "CA", "IL".
269
- # * city: histogram by a combination of the "city name, admin1 code". For
270
- # example, "Mountain View, CA", "New York, NY".
271
- # * admin1_country: histogram by a combination of the "admin1 code, country",
272
- # for example, "CA, US", "IL, US".
273
- # * city_coordinate: histogram by the city center's GPS coordinates (latitude
274
- # and longitude), for example, 37.4038522,-122.0987765. Since the
275
- # coordinates of a city center can change, customers may need to refresh
276
- # them periodically.
277
- # * locale: histogram by the
278
- # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}, for
279
- # example, "en-US",
280
- # "fr-FR".
281
- # * language: histogram by the language subtag of the
282
- # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code},
283
- # for example, "en", "fr".
284
- # * category: histogram by the
285
- # {Google::Cloud::Talent::V4beta1::JobCategory JobCategory}, for example,
286
- # "COMPUTER_AND_IT", "HEALTHCARE".
287
- # * base_compensation_unit: histogram by the
288
- # {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationUnit CompensationInfo::CompensationUnit}
289
- # of base salary, for example, "WEEKLY", "MONTHLY".
290
- # * base_compensation: histogram by the base salary. Must specify list of
291
- # numeric buckets to group results by.
292
- # * annualized_base_compensation: histogram by the base annualized salary.
293
- # Must specify list of numeric buckets to group results by.
294
- # * annualized_total_compensation: histogram by the total annualized salary.
295
- # Must specify list of numeric buckets to group results by.
296
- # * string_custom_attribute: histogram by string
297
- # {Google::Cloud::Talent::V4beta1::Job#custom_attributes Job#custom_attributes}.
298
- # Values can be accessed via square bracket notations like
299
- # string_custom_attribute["key1"].
300
- # * numeric_custom_attribute: histogram by numeric
301
- # {Google::Cloud::Talent::V4beta1::Job#custom_attributes Job#custom_attributes}.
302
- # Values can be accessed via square bracket notations like
303
- # numeric_custom_attribute["key1"]. Must specify list of numeric buckets to
304
- # group results by.
305
- #
306
- # Example expressions:
307
- #
308
- # * `count(admin1)`
309
- # * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000),
310
- # bucket(100000, MAX)])`
311
- # * `count(string_custom_attribute["some-string-custom-attribute"])`
312
- # * `count(numeric_custom_attribute["some-numeric-custom-attribute"],
313
- # [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"])`
314
- # @!attribute [rw] job_view
315
- # @return [Google::Cloud::Talent::V4beta1::JobView]
316
- # The desired job attributes returned for jobs in the search response.
317
- # Defaults to
318
- # {Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_SMALL JobView::JOB_VIEW_SMALL}
319
- # if no value is specified.
320
- # @!attribute [rw] offset
321
- # @return [Integer]
322
- # An integer that specifies the current offset (that is, starting result
323
- # location, amongst the jobs deemed by the API as relevant) in search
324
- # results. This field is only considered if
325
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#page_token page_token} is
326
- # unset.
327
- #
328
- # For example, 0 means to return results starting from the first matching
329
- # job, and 10 means to return from the 11th job. This can be used for
330
- # pagination, (for example, pageSize = 10 and offset = 10 means to return
331
- # from the second page).
332
- # @!attribute [rw] page_size
333
- # @return [Integer]
334
- # A limit on the number of jobs returned in the search results.
335
- # Increasing this value above the default value of 10 can increase search
336
- # response time. The value can be between 1 and 100.
337
- # @!attribute [rw] page_token
338
- # @return [String]
339
- # The token specifying the current offset within
340
- # search results. See
341
- # {Google::Cloud::Talent::V4beta1::SearchJobsResponse#next_page_token SearchJobsResponse#next_page_token}
342
- # for an explanation of how to obtain the next set of query results.
343
- # @!attribute [rw] order_by
344
- # @return [String]
345
- # The criteria determining how search results are sorted. Default is
346
- # `"relevance desc"`.
347
- #
348
- # Supported options are:
349
- #
350
- # * `"relevance desc"`: By relevance descending, as determined by the API
351
- # algorithms. Relevance thresholding of query results is only available
352
- # with this ordering.
353
- # * `"posting_publish_time desc"`: By
354
- # {Google::Cloud::Talent::V4beta1::Job#posting_publish_time Job#posting_publish_time}
355
- # descending.
356
- # * `"posting_update_time desc"`: By
357
- # {Google::Cloud::Talent::V4beta1::Job#posting_update_time Job#posting_update_time}
358
- # descending.
359
- # * `"title"`: By {Google::Cloud::Talent::V4beta1::Job#title Job#title}
360
- # ascending.
361
- # * `"title desc"`: By {Google::Cloud::Talent::V4beta1::Job#title Job#title}
362
- # descending.
363
- # * `"annualized_base_compensation"`: By job's
364
- # {Google::Cloud::Talent::V4beta1::CompensationInfo#annualized_base_compensation_range CompensationInfo#annualized_base_compensation_range}
365
- # ascending. Jobs whose annualized base compensation is unspecified are put
366
- # at the end of search results.
367
- # * `"annualized_base_compensation desc"`: By job's
368
- # {Google::Cloud::Talent::V4beta1::CompensationInfo#annualized_base_compensation_range CompensationInfo#annualized_base_compensation_range}
369
- # descending. Jobs whose annualized base compensation is unspecified are
370
- # put at the end of search results.
371
- # * `"annualized_total_compensation"`: By job's
372
- # {Google::Cloud::Talent::V4beta1::CompensationInfo#annualized_total_compensation_range CompensationInfo#annualized_total_compensation_range}
373
- # ascending. Jobs whose annualized base compensation is unspecified are put
374
- # at the end of search results.
375
- # * `"annualized_total_compensation desc"`: By job's
376
- # {Google::Cloud::Talent::V4beta1::CompensationInfo#annualized_total_compensation_range CompensationInfo#annualized_total_compensation_range}
377
- # descending. Jobs whose annualized base compensation is unspecified are
378
- # put at the end of search results.
379
- # * `"custom_ranking desc"`: By the relevance score adjusted to the
380
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression SearchJobsRequest::CustomRankingInfo#ranking_expression}
381
- # with weight factor assigned by
382
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#importance_level SearchJobsRequest::CustomRankingInfo#importance_level}
383
- # in descending order.
384
- # * Location sorting: Use the special syntax to order jobs by distance:<br>
385
- # `"distance_from('Hawaii')"`: Order by distance from Hawaii.<br>
386
- # `"distance_from(19.89, 155.5)"`: Order by distance from a coordinate.<br>
387
- # `"distance_from('Hawaii'), distance_from('Puerto Rico')"`: Order by
388
- # multiple locations. See details below.<br>
389
- # `"distance_from('Hawaii'), distance_from(19.89, 155.5)"`: Order by
390
- # multiple locations. See details below.<br>
391
- # The string can have a maximum of 256 characters. When multiple distance
392
- # centers are provided, a job that is close to any of the distance centers
393
- # would have a high rank. When a job has multiple locations, the job
394
- # location closest to one of the distance centers will be used. Jobs that
395
- # don't have locations will be ranked at the bottom. Distance is calculated
396
- # with a precision of 11.3 meters (37.4 feet). Diversification strategy is
397
- # still applied unless explicitly disabled in
398
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#diversification_level diversification_level}.
399
- # @!attribute [rw] diversification_level
400
- # @return [Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel]
401
- # Controls whether highly similar jobs are returned next to each other in
402
- # the search results. Jobs are identified as highly similar based on
403
- # their titles, job categories, and locations. Highly similar results are
404
- # clustered so that only one representative job of the cluster is
405
- # displayed to the job seeker higher up in the results, with the other jobs
406
- # being displayed lower down in the results.
407
- #
408
- # Defaults to
409
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel::SIMPLE}
410
- # if no value is specified.
411
- # @!attribute [rw] custom_ranking_info
412
- # @return [Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo]
413
- # Controls over how job documents get ranked on top of existing relevance
414
- # score (determined by API algorithm).
415
- # @!attribute [rw] disable_keyword_match
416
- # @return [true, false]
417
- # Controls whether to disable exact keyword match on
418
- # {Google::Cloud::Talent::V4beta1::Job#title Job#title},
419
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description},
420
- # {Google::Cloud::Talent::V4beta1::Job#company_display_name Job#company_display_name},
421
- # {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses},
422
- # {Google::Cloud::Talent::V4beta1::Job#qualifications Job#qualifications}. When
423
- # disable keyword match is turned off, a keyword match returns jobs that do
424
- # not match given category filters when there are matching keywords. For
425
- # example, for the query "program manager," a result is returned even if the
426
- # job posting has the title "software developer," which doesn't fall into
427
- # "program manager" ontology, but does have "program manager" appearing in
428
- # its description.
429
- #
430
- # For queries like "cloud" that don't contain title or
431
- # location specific ontology, jobs with "cloud" keyword matches are returned
432
- # regardless of this flag's value.
433
- #
434
- # Use
435
- # {Google::Cloud::Talent::V4beta1::Company#keyword_searchable_job_custom_attributes Company#keyword_searchable_job_custom_attributes}
436
- # if company-specific globally matched custom field/attribute string values
437
- # are needed. Enabling keyword match improves recall of subsequent search
438
- # requests.
439
- #
440
- # Defaults to false.
441
- class SearchJobsRequest
442
- # Custom ranking information for
443
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
444
- # @!attribute [rw] importance_level
445
- # @return [Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo::ImportanceLevel]
446
- # Required. Controls over how important the score of
447
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression CustomRankingInfo#ranking_expression}
448
- # gets applied to job's final ranking position.
449
- #
450
- # An error is thrown if not specified.
451
- # @!attribute [rw] ranking_expression
452
- # @return [String]
453
- # Required. Controls over how job documents get ranked on top of existing
454
- # relevance score (determined by API algorithm). The product of ranking
455
- # expression and relevance score is used to determine job's final ranking
456
- # position.
457
- #
458
- # The syntax for this expression is a subset of Google SQL syntax.
459
- #
460
- # Supported operators are: +, -, *, /, where the left and right side of
461
- # the operator is either a numeric
462
- # {Google::Cloud::Talent::V4beta1::Job#custom_attributes Job#custom_attributes}
463
- # key, integer/double value or an expression that can be evaluated to a
464
- # number.
465
- #
466
- # Parenthesis are supported to adjust calculation precedence. The
467
- # expression must be < 100 characters in length.
468
- #
469
- # Sample ranking expression
470
- # (year + 25) * 0.25 - (freshness / 0.5)
471
- class CustomRankingInfo
472
- # The importance level for
473
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression CustomRankingInfo#ranking_expression}.
474
- module ImportanceLevel
475
- # Default value if the importance level isn't specified.
476
- IMPORTANCE_LEVEL_UNSPECIFIED = 0
477
-
478
- # The given ranking expression is of None importance, existing relevance
479
- # score (determined by API algorithm) dominates job's final ranking
480
- # position.
481
- NONE = 1
482
-
483
- # The given ranking expression is of Low importance in terms of job's
484
- # final ranking position compared to existing relevance
485
- # score (determined by API algorithm).
486
- LOW = 2
487
-
488
- # The given ranking expression is of Mild importance in terms of job's
489
- # final ranking position compared to existing relevance
490
- # score (determined by API algorithm).
491
- MILD = 3
492
-
493
- # The given ranking expression is of Medium importance in terms of job's
494
- # final ranking position compared to existing relevance
495
- # score (determined by API algorithm).
496
- MEDIUM = 4
497
-
498
- # The given ranking expression is of High importance in terms of job's
499
- # final ranking position compared to existing relevance
500
- # score (determined by API algorithm).
501
- HIGH = 5
502
-
503
- # The given ranking expression is of Extreme importance, and dominates
504
- # job's final ranking position with existing relevance
505
- # score (determined by API algorithm) ignored.
506
- EXTREME = 6
507
- end
508
- end
509
-
510
- # Controls whether highly similar jobs are returned next to each other in
511
- # the search results. Jobs are identified as highly similar based on
512
- # their titles, job categories, and locations. Highly similar results are
513
- # clustered so that only one representative job of the cluster is
514
- # displayed to the job seeker higher up in the results, with the other jobs
515
- # being displayed lower down in the results.
516
- module DiversificationLevel
517
- # The diversification level isn't specified.
518
- DIVERSIFICATION_LEVEL_UNSPECIFIED = 0
519
-
520
- # Disables diversification. Jobs that would normally be pushed to the last
521
- # page would not have their positions altered. This may result in highly
522
- # similar jobs appearing in sequence in the search results.
523
- DISABLED = 1
524
-
525
- # Default diversifying behavior. The result list is ordered so that
526
- # highly similar results are pushed to the end of the last page of search
527
- # results.
528
- SIMPLE = 2
529
- end
530
-
531
- # A string-represented enumeration of the job search mode. The service
532
- # operate differently for different modes of service.
533
- module SearchMode
534
- # The mode of the search method isn't specified. The default search
535
- # behavior is identical to JOB_SEARCH search behavior.
536
- SEARCH_MODE_UNSPECIFIED = 0
537
-
538
- # The job search matches against all jobs, and featured jobs
539
- # (jobs with promotionValue > 0) are not specially handled.
540
- JOB_SEARCH = 1
541
-
542
- # The job search matches only against featured jobs (jobs with a
543
- # promotionValue > 0). This method doesn't return any jobs having a
544
- # promotionValue <= 0. The search results order is determined by the
545
- # promotionValue (jobs with a higher promotionValue are returned higher up
546
- # in the search results), with relevance being used as a tiebreaker.
547
- FEATURED_JOB_SEARCH = 2
548
- end
549
- end
550
-
551
- # Response for SearchJob method.
552
- # @!attribute [rw] matching_jobs
553
- # @return [Array<Google::Cloud::Talent::V4beta1::SearchJobsResponse::MatchingJob>]
554
- # The Job entities that match the specified
555
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
556
- # @!attribute [rw] histogram_query_results
557
- # @return [Array<Google::Cloud::Talent::V4beta1::HistogramQueryResult>]
558
- # The histogram results that match with specified
559
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#histogram_queries SearchJobsRequest#histogram_queries}.
560
- # @!attribute [rw] next_page_token
561
- # @return [String]
562
- # The token that specifies the starting position of the next page of results.
563
- # This field is empty if there are no more results.
564
- # @!attribute [rw] location_filters
565
- # @return [Array<Google::Cloud::Talent::V4beta1::Location>]
566
- # The location filters that the service applied to the specified query. If
567
- # any filters are lat-lng based, the
568
- # {Google::Cloud::Talent::V4beta1::Location#location_type Location#location_type}
569
- # is
570
- # {Google::Cloud::Talent::V4beta1::Location::LocationType::LOCATION_TYPE_UNSPECIFIED Location::LocationType::LOCATION_TYPE_UNSPECIFIED}.
571
- # @!attribute [rw] estimated_total_size
572
- # @return [Integer]
573
- # An estimation of the number of jobs that match the specified query.
574
- #
575
- # This number isn't guaranteed to be accurate. For accurate results,
576
- # see
577
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#require_precise_result_size SearchJobsRequest#require_precise_result_size}.
578
- # @!attribute [rw] total_size
579
- # @return [Integer]
580
- # The precise result count, which is available only if the client set
581
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#require_precise_result_size SearchJobsRequest#require_precise_result_size}
582
- # to `true`, or if the response is the last page of results. Otherwise, the
583
- # value is `-1`.
584
- # @!attribute [rw] metadata
585
- # @return [Google::Cloud::Talent::V4beta1::ResponseMetadata]
586
- # Additional information for the API invocation, such as the request
587
- # tracking id.
588
- # @!attribute [rw] broadened_query_jobs_count
589
- # @return [Integer]
590
- # If query broadening is enabled, we may append additional results from the
591
- # broadened query. This number indicates how many of the jobs returned in the
592
- # jobs field are from the broadened query. These results are always at the
593
- # end of the jobs list. In particular, a value of 0, or if the field isn't
594
- # set, all the jobs in the jobs list are from the original
595
- # (without broadening) query. If this field is non-zero, subsequent requests
596
- # with offset after this result set should contain all broadened results.
597
- # @!attribute [rw] spell_correction
598
- # @return [Google::Cloud::Talent::V4beta1::SpellingCorrection]
599
- # The spell checking result, and correction.
600
- class SearchJobsResponse
601
- # Job entry with metadata inside
602
- # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
603
- # @!attribute [rw] job
604
- # @return [Google::Cloud::Talent::V4beta1::Job]
605
- # Job resource that matches the specified
606
- # {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
607
- # @!attribute [rw] job_summary
608
- # @return [String]
609
- # A summary of the job with core information that's displayed on the search
610
- # results listing page.
611
- # @!attribute [rw] job_title_snippet
612
- # @return [String]
613
- # Contains snippets of text from the
614
- # {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
615
- # matching a search query's keywords, if available. The matching query
616
- # keywords are enclosed in HTML bold tags.
617
- # @!attribute [rw] search_text_snippet
618
- # @return [String]
619
- # Contains snippets of text from the
620
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
621
- # similar fields that most closely match a search query's keywords, if
622
- # available. All HTML tags in the original fields are stripped when
623
- # returned in this field, and matching query keywords are enclosed in HTML
624
- # bold tags.
625
- # @!attribute [rw] commute_info
626
- # @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
627
- # Commute information which is generated based on specified
628
- # {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
629
- class MatchingJob; end
630
-
631
- # Commute details related to this job.
632
- # @!attribute [rw] job_location
633
- # @return [Google::Cloud::Talent::V4beta1::Location]
634
- # Location used as the destination in the commute calculation.
635
- # @!attribute [rw] travel_duration
636
- # @return [Google::Protobuf::Duration]
637
- # The number of seconds required to travel to the job location from the
638
- # query location. A duration of 0 seconds indicates that the job isn't
639
- # reachable within the requested duration, but was returned as part of an
640
- # expanded query.
641
- class CommuteInfo; end
642
- end
643
-
644
- # Request to create a batch of jobs.
645
- # @!attribute [rw] parent
646
- # @return [String]
647
- # Required. The resource name of the tenant under which the job is created.
648
- #
649
- # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
650
- # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
651
- # is created. For example, "projects/foo".
652
- # @!attribute [rw] jobs
653
- # @return [Array<Google::Cloud::Talent::V4beta1::Job>]
654
- # Required. The jobs to be created.
655
- class BatchCreateJobsRequest; end
656
-
657
- # Request to update a batch of jobs.
658
- # @!attribute [rw] parent
659
- # @return [String]
660
- # Required. The resource name of the tenant under which the job is created.
661
- #
662
- # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
663
- # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
664
- # is created. For example, "projects/foo".
665
- # @!attribute [rw] jobs
666
- # @return [Array<Google::Cloud::Talent::V4beta1::Job>]
667
- # Required. The jobs to be updated.
668
- # @!attribute [rw] update_mask
669
- # @return [Google::Protobuf::FieldMask]
670
- # Strongly recommended for the best service experience. Be aware that it will
671
- # also increase latency when checking the status of a batch operation.
672
- #
673
- # If
674
- # {Google::Cloud::Talent::V4beta1::BatchUpdateJobsRequest#update_mask update_mask}
675
- # is provided, only the specified fields in
676
- # {Google::Cloud::Talent::V4beta1::Job Job} are updated. Otherwise all the
677
- # fields are updated.
678
- #
679
- # A field mask to restrict the fields that are updated. Only
680
- # top level fields of {Google::Cloud::Talent::V4beta1::Job Job} are supported.
681
- #
682
- # If
683
- # {Google::Cloud::Talent::V4beta1::BatchUpdateJobsRequest#update_mask update_mask}
684
- # is provided, The {Google::Cloud::Talent::V4beta1::Job Job} inside
685
- # {Google::Cloud::Talent::V4beta1::JobOperationResult::JobResult JobResult}
686
- # will only contains fields that is updated, plus the Id of the Job.
687
- # Otherwise, {Google::Cloud::Talent::V4beta1::Job Job} will include all fields,
688
- # which can yield a very large response.
689
- class BatchUpdateJobsRequest; end
690
-
691
- # The result of
692
- # {Google::Cloud::Talent::V4beta1::JobService::BatchCreateJobs JobService::BatchCreateJobs}
693
- # or
694
- # {Google::Cloud::Talent::V4beta1::JobService::BatchUpdateJobs JobService::BatchUpdateJobs}
695
- # APIs. It's used to replace
696
- # {Google::Longrunning::Operation#response}
697
- # in case of success.
698
- # @!attribute [rw] job_results
699
- # @return [Array<Google::Cloud::Talent::V4beta1::JobOperationResult::JobResult>]
700
- # List of job mutation results from a batch mutate operation. It can change
701
- # until operation status is FINISHED, FAILED or CANCELLED.
702
- class JobOperationResult
703
- # Mutation result of a job.
704
- # @!attribute [rw] job
705
- # @return [Google::Cloud::Talent::V4beta1::Job]
706
- # Here {Google::Cloud::Talent::V4beta1::Job Job} only contains basic
707
- # information including {Google::Cloud::Talent::V4beta1::Job#name name},
708
- # {Google::Cloud::Talent::V4beta1::Job#company company},
709
- # {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and
710
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}, use
711
- # getJob method to retrieve detailed information of the created/updated
712
- # job.
713
- # @!attribute [rw] status
714
- # @return [Google::Rpc::Status]
715
- # The status of the job processed. This field is populated if the
716
- # processing of the
717
- # {Google::Cloud::Talent::V4beta1::JobOperationResult::JobResult#job job}
718
- # fails.
719
- class JobResult; end
720
- end
721
-
722
- # An enum that specifies the job attributes that are returned in the
723
- # {Google::Cloud::Talent::V4beta1::SearchJobsResponse::MatchingJob#job MatchingJob#job}
724
- # or {Google::Cloud::Talent::V4beta1::ListJobsResponse#jobs ListJobsResponse#jobs}
725
- # fields.
726
- module JobView
727
- # Default value.
728
- JOB_VIEW_UNSPECIFIED = 0
729
-
730
- # A ID only view of job, with following attributes:
731
- # {Google::Cloud::Talent::V4beta1::Job#name Job#name},
732
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id},
733
- # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}.
734
- JOB_VIEW_ID_ONLY = 1
735
-
736
- # A minimal view of the job, with the following attributes:
737
- # {Google::Cloud::Talent::V4beta1::Job#name Job#name},
738
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id},
739
- # {Google::Cloud::Talent::V4beta1::Job#title Job#title},
740
- # {Google::Cloud::Talent::V4beta1::Job#company Job#company},
741
- # {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations Job::DerivedInfo#locations},
742
- # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}.
743
- JOB_VIEW_MINIMAL = 2
744
-
745
- # A small view of the job, with the following attributes in the search
746
- # results: {Google::Cloud::Talent::V4beta1::Job#name Job#name},
747
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id},
748
- # {Google::Cloud::Talent::V4beta1::Job#title Job#title},
749
- # {Google::Cloud::Talent::V4beta1::Job#company Job#company},
750
- # {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations Job::DerivedInfo#locations},
751
- # {Google::Cloud::Talent::V4beta1::Job#visibility Job#visibility},
752
- # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code},
753
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description}.
754
- JOB_VIEW_SMALL = 3
755
-
756
- # All available attributes are included in the search results.
757
- JOB_VIEW_FULL = 4
758
- end
759
- end
760
- end
761
- end
762
- end