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