google-cloud-talent 0.5.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/talent/v4beta1.rb +2 -1
  3. data/lib/google/cloud/talent/v4beta1/application_pb.rb +1 -0
  4. data/lib/google/cloud/talent/v4beta1/application_service_client.rb +8 -11
  5. data/lib/google/cloud/talent/v4beta1/application_service_pb.rb +1 -0
  6. data/lib/google/cloud/talent/v4beta1/batch_pb.rb +0 -33
  7. data/lib/google/cloud/talent/v4beta1/common_pb.rb +30 -0
  8. data/lib/google/cloud/talent/v4beta1/company_pb.rb +1 -0
  9. data/lib/google/cloud/talent/v4beta1/company_service_client.rb +11 -14
  10. data/lib/google/cloud/talent/v4beta1/company_service_pb.rb +1 -0
  11. data/lib/google/cloud/talent/v4beta1/completion_client.rb +10 -10
  12. data/lib/google/cloud/talent/v4beta1/completion_service_pb.rb +1 -0
  13. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application.rb +17 -19
  14. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application_service.rb +10 -15
  15. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb +200 -49
  16. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company.rb +15 -15
  17. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company_service.rb +13 -18
  18. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb +10 -16
  19. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb +11 -12
  20. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event_service.rb +2 -4
  21. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb +210 -177
  22. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/histogram.rb +0 -4
  23. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb +47 -54
  24. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb +92 -100
  25. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb +168 -114
  26. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb +55 -36
  27. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant.rb +4 -4
  28. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant_service.rb +7 -10
  29. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/timestamp.rb +6 -4
  30. data/lib/google/cloud/talent/v4beta1/event_pb.rb +1 -0
  31. data/lib/google/cloud/talent/v4beta1/event_service_client.rb +2 -4
  32. data/lib/google/cloud/talent/v4beta1/event_service_pb.rb +1 -0
  33. data/lib/google/cloud/talent/v4beta1/filters_pb.rb +8 -0
  34. data/lib/google/cloud/talent/v4beta1/job_pb.rb +1 -0
  35. data/lib/google/cloud/talent/v4beta1/job_service_client.rb +76 -97
  36. data/lib/google/cloud/talent/v4beta1/job_service_pb.rb +11 -1
  37. data/lib/google/cloud/talent/v4beta1/job_service_services_pb.rb +6 -6
  38. data/lib/google/cloud/talent/v4beta1/profile_pb.rb +9 -0
  39. data/lib/google/cloud/talent/v4beta1/profile_service_client.rb +50 -27
  40. data/lib/google/cloud/talent/v4beta1/profile_service_pb.rb +3 -0
  41. data/lib/google/cloud/talent/v4beta1/tenant_pb.rb +1 -0
  42. data/lib/google/cloud/talent/v4beta1/tenant_service_client.rb +5 -6
  43. data/lib/google/cloud/talent/v4beta1/tenant_service_pb.rb +1 -0
  44. data/lib/google/cloud/talent/version.rb +1 -1
  45. metadata +22 -2
@@ -23,25 +23,43 @@ module Google
23
23
  # Required. The resource name of the tenant under which the profile is
24
24
  # created.
25
25
  #
26
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
27
- # "projects/api-test-project/tenants/foo".
26
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
27
+ # "projects/foo/tenants/bar".
28
+ # @!attribute [rw] filter
29
+ # @return [String]
30
+ # The filter string specifies the profiles to be enumerated.
31
+ #
32
+ # Supported operator: =, AND
33
+ #
34
+ # The field(s) eligible for filtering are:
35
+ #
36
+ # * `externalId`
37
+ # * `groupId`
38
+ #
39
+ # externalId and groupId cannot be specified at the same time. If both
40
+ # externalId and groupId are provided, the API will return a bad request
41
+ # error.
42
+ #
43
+ # Sample Query:
44
+ #
45
+ # * externalId = "externalId-1"
46
+ # * groupId = "groupId-1"
28
47
  # @!attribute [rw] page_token
29
48
  # @return [String]
30
- # Optional. The token that specifies the current offset (that is, starting
31
- # result).
49
+ # The token that specifies the current offset (that is, starting result).
32
50
  #
33
51
  # Please set the value to
34
52
  # {Google::Cloud::Talent::V4beta1::ListProfilesResponse#next_page_token ListProfilesResponse#next_page_token}
35
53
  # to continue the list.
36
54
  # @!attribute [rw] page_size
37
55
  # @return [Integer]
38
- # Optional. The maximum number of profiles to be returned, at most 100.
56
+ # The maximum number of profiles to be returned, at most 100.
39
57
  #
40
58
  # Default is 100 unless a positive number smaller than 100 is specified.
41
59
  # @!attribute [rw] read_mask
42
60
  # @return [Google::Protobuf::FieldMask]
43
- # Optional. A field mask to specify the profile fields to be listed in
44
- # response. All fields are listed if it is unset.
61
+ # A field mask to specify the profile fields to be listed in response.
62
+ # All fields are listed if it is unset.
45
63
  #
46
64
  # Valid values are:
47
65
  #
@@ -63,8 +81,8 @@ module Google
63
81
  # @return [String]
64
82
  # Required. The name of the tenant this profile belongs to.
65
83
  #
66
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
67
- # "projects/api-test-project/tenants/foo".
84
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
85
+ # "projects/foo/tenants/bar".
68
86
  # @!attribute [rw] profile
69
87
  # @return [Google::Cloud::Talent::V4beta1::Profile]
70
88
  # Required. The profile to be created.
@@ -76,8 +94,8 @@ module Google
76
94
  # Required. Resource name of the profile to get.
77
95
  #
78
96
  # The format is
79
- # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
80
- # for example, "projects/api-test-project/tenants/foo/profiles/bar".
97
+ # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For
98
+ # example, "projects/foo/tenants/bar/profiles/baz".
81
99
  class GetProfileRequest; end
82
100
 
83
101
  # Update profile request
@@ -86,17 +104,21 @@ module Google
86
104
  # Required. Profile to be updated.
87
105
  # @!attribute [rw] update_mask
88
106
  # @return [Google::Protobuf::FieldMask]
89
- # Optional. A field mask to specify the profile fields to update.
107
+ # A field mask to specify the profile fields to update.
90
108
  #
91
109
  # A full update is performed if it is unset.
92
110
  #
93
111
  # Valid values are:
112
+ #
94
113
  # * external_id
95
114
  # * source
115
+ # * source_types
96
116
  # * uri
97
117
  # * is_hirable
98
118
  # * create_time
99
119
  # * update_time
120
+ # * candidate_update_time
121
+ # * resume_update_time
100
122
  # * resume
101
123
  # * person_names
102
124
  # * addresses
@@ -142,8 +164,8 @@ module Google
142
164
  # Required. Resource name of the profile to be deleted.
143
165
  #
144
166
  # The format is
145
- # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
146
- # for example, "projects/api-test-project/tenants/foo/profiles/bar".
167
+ # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For
168
+ # example, "projects/foo/tenants/bar/profiles/baz".
147
169
  class DeleteProfileRequest; end
148
170
 
149
171
  # The request body of the `SearchProfiles` call.
@@ -151,8 +173,8 @@ module Google
151
173
  # @return [String]
152
174
  # Required. The resource name of the tenant to search within.
153
175
  #
154
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
155
- # "projects/api-test-project/tenants/foo".
176
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
177
+ # "projects/foo/tenants/bar".
156
178
  # @!attribute [rw] request_metadata
157
179
  # @return [Google::Cloud::Talent::V4beta1::RequestMetadata]
158
180
  # Required. The meta information collected about the profile search user.
@@ -160,27 +182,27 @@ module Google
160
182
  # provided by users, and must be precise and consistent.
161
183
  # @!attribute [rw] profile_query
162
184
  # @return [Google::Cloud::Talent::V4beta1::ProfileQuery]
163
- # Optional. Search query to execute. See
185
+ # Search query to execute. See
164
186
  # {Google::Cloud::Talent::V4beta1::ProfileQuery ProfileQuery} for more details.
165
187
  # @!attribute [rw] page_size
166
188
  # @return [Integer]
167
- # Optional. A limit on the number of profiles returned in the search results.
189
+ # A limit on the number of profiles returned in the search results.
168
190
  # A value above the default value 10 can increase search response time.
169
191
  #
170
192
  # The maximum value allowed is 100. Otherwise an error is thrown.
171
193
  # @!attribute [rw] page_token
172
194
  # @return [String]
173
- # Optional. The pageToken, similar to offset enables users of the API to
174
- # paginate through the search results. To retrieve the first page of results,
175
- # set the pageToken to empty. The search response includes a
195
+ # The pageToken, similar to offset enables users of the API to paginate
196
+ # through the search results. To retrieve the first page of results, set the
197
+ # pageToken to empty. The search response includes a
176
198
  # {Google::Cloud::Talent::V4beta1::SearchProfilesResponse#next_page_token nextPageToken}
177
199
  # field that can be used to populate the pageToken field for the next page of
178
200
  # results. Using pageToken instead of offset increases the performance of the
179
201
  # API, especially compared to larger offset values.
180
202
  # @!attribute [rw] offset
181
203
  # @return [Integer]
182
- # Optional. An integer that specifies the current offset (that is, starting
183
- # result) in search results. This field is only considered if
204
+ # An integer that specifies the current offset (that is, starting result) in
205
+ # search results. This field is only considered if
184
206
  # {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#page_token page_token}
185
207
  # is unset.
186
208
  #
@@ -191,13 +213,13 @@ module Google
191
213
  # pageSize = 10 and offset = 10 means to search from the second page.
192
214
  # @!attribute [rw] disable_spell_check
193
215
  # @return [true, false]
194
- # Optional. This flag controls the spell-check feature. If `false`, the
216
+ # This flag controls the spell-check feature. If `false`, the
195
217
  # service attempts to correct a misspelled query.
196
218
  #
197
219
  # For example, "enginee" is corrected to "engineer".
198
220
  # @!attribute [rw] order_by
199
221
  # @return [String]
200
- # Optional. The criteria that determines how search results are sorted.
222
+ # The criteria that determines how search results are sorted.
201
223
  # Defaults is "relevance desc" if no value is specified.
202
224
  #
203
225
  # Supported options are:
@@ -228,17 +250,16 @@ module Google
228
250
  # in ascending order.
229
251
  # @!attribute [rw] case_sensitive_sort
230
252
  # @return [true, false]
231
- # Optional. When sort by field is based on alphabetical order, sort values
232
- # case sensitively (based on ASCII) when the value is set to true. Default
233
- # value is case in-sensitive sort (false).
253
+ # When sort by field is based on alphabetical order, sort values case
254
+ # sensitively (based on ASCII) when the value is set to true. Default value
255
+ # is case in-sensitive sort (false).
234
256
  # @!attribute [rw] histogram_queries
235
257
  # @return [Array<Google::Cloud::Talent::V4beta1::HistogramQuery>]
236
- # Optional. A list of expressions specifies histogram requests against
237
- # matching profiles for
258
+ # A list of expressions specifies histogram requests against matching
259
+ # profiles for
238
260
  # {Google::Cloud::Talent::V4beta1::SearchProfilesRequest SearchProfilesRequest}.
239
261
  #
240
- # The expression syntax looks like a function definition with optional
241
- # parameters.
262
+ # The expression syntax looks like a function definition with parameters.
242
263
  #
243
264
  # Function syntax: function_name(histogram_facet[, list of buckets])
244
265
  #
@@ -317,7 +338,7 @@ module Google
317
338
  # [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
318
339
  # @!attribute [rw] result_set_id
319
340
  # @return [String]
320
- # Optional. An id that uniquely identifies the result set of a
341
+ # An id that uniquely identifies the result set of a
321
342
  # {Google::Cloud::Talent::V4beta1::ProfileService::SearchProfiles SearchProfiles}
322
343
  # call. The id should be retrieved from the
323
344
  # {Google::Cloud::Talent::V4beta1::SearchProfilesResponse SearchProfilesResponse}
@@ -349,7 +370,7 @@ module Google
349
370
  # to page through the results.
350
371
  # @!attribute [rw] strict_keywords_search
351
372
  # @return [true, false]
352
- # Optional. This flag is used to indicate whether the service will attempt to
373
+ # This flag is used to indicate whether the service will attempt to
353
374
  # understand synonyms and terms related to the search query or treat the
354
375
  # query "as is" when it generates a set of results. By default this flag is
355
376
  # set to false, thus allowing expanded results to also be returned. For
@@ -396,8 +417,6 @@ module Google
396
417
  # call for consistent results.
397
418
  class SearchProfilesResponse; end
398
419
 
399
- # Output only.
400
- #
401
420
  # Profile entry with metadata inside
402
421
  # {Google::Cloud::Talent::V4beta1::SearchProfilesResponse SearchProfilesResponse}.
403
422
  # @!attribute [rw] profiles
@@ -29,7 +29,7 @@ module Google
29
29
  # tenant is created.
30
30
  #
31
31
  # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
32
- # "projects/api-test-project/tenants/foo".
32
+ # "projects/foo/tenants/bar".
33
33
  # @!attribute [rw] external_id
34
34
  # @return [String]
35
35
  # Required. Client side tenant identifier, used to uniquely identify the
@@ -38,15 +38,15 @@ module Google
38
38
  # The maximum number of allowed characters is 255.
39
39
  # @!attribute [rw] usage_type
40
40
  # @return [Google::Cloud::Talent::V4beta1::Tenant::DataUsageType]
41
- # Optional. Indicates whether data owned by this tenant may be used to
42
- # provide product improvements across other tenants.
41
+ # Indicates whether data owned by this tenant may be used to provide product
42
+ # improvements across other tenants.
43
43
  #
44
44
  # Defaults behavior is
45
45
  # {Google::Cloud::Talent::V4beta1::Tenant::DataUsageType::ISOLATED DataUsageType::ISOLATED}
46
46
  # if it's unset.
47
47
  # @!attribute [rw] keyword_searchable_profile_custom_attributes
48
48
  # @return [Array<String>]
49
- # Optional. A list of keys of filterable
49
+ # A list of keys of filterable
50
50
  # {Google::Cloud::Talent::V4beta1::Profile#custom_attributes Profile#custom_attributes},
51
51
  # whose corresponding `string_values` are used in keyword searches. Profiles
52
52
  # with `string_values` under these specified field keys are returned if any
@@ -23,7 +23,7 @@ module Google
23
23
  # Required. Resource name of the project under which the tenant is created.
24
24
  #
25
25
  # The format is "projects/{project_id}", for example,
26
- # "projects/api-test-project".
26
+ # "projects/foo".
27
27
  # @!attribute [rw] tenant
28
28
  # @return [Google::Cloud::Talent::V4beta1::Tenant]
29
29
  # Required. The tenant to be created.
@@ -35,7 +35,7 @@ module Google
35
35
  # Required. The resource name of the tenant to be retrieved.
36
36
  #
37
37
  # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
38
- # "projects/api-test-project/tenants/foo".
38
+ # "projects/foo/tenants/bar".
39
39
  class GetTenantRequest; end
40
40
 
41
41
  # Request for updating a specified tenant.
@@ -45,8 +45,7 @@ module Google
45
45
  # system.
46
46
  # @!attribute [rw] update_mask
47
47
  # @return [Google::Protobuf::FieldMask]
48
- # Optional but strongly recommended for the best service
49
- # experience.
48
+ # Strongly recommended for the best service experience.
50
49
  #
51
50
  # If
52
51
  # {Google::Cloud::Talent::V4beta1::UpdateTenantRequest#update_mask update_mask}
@@ -65,7 +64,7 @@ module Google
65
64
  # Required. The resource name of the tenant to be deleted.
66
65
  #
67
66
  # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
68
- # "projects/api-test-project/tenants/foo".
67
+ # "projects/foo/tenants/bar".
69
68
  class DeleteTenantRequest; end
70
69
 
71
70
  # List tenants for which the client has ACL visibility.
@@ -74,18 +73,16 @@ module Google
74
73
  # Required. Resource name of the project under which the tenant is created.
75
74
  #
76
75
  # The format is "projects/{project_id}", for example,
77
- # "projects/api-test-project".
76
+ # "projects/foo".
78
77
  # @!attribute [rw] page_token
79
78
  # @return [String]
80
- # Optional. The starting indicator from which to return results.
79
+ # The starting indicator from which to return results.
81
80
  # @!attribute [rw] page_size
82
81
  # @return [Integer]
83
- # Optional. The maximum number of tenants to be returned, at most 100.
82
+ # The maximum number of tenants to be returned, at most 100.
84
83
  # Default is 100 if a non-positive number is provided.
85
84
  class ListTenantsRequest; end
86
85
 
87
- # Output only.
88
- #
89
86
  # The List tenants response object.
90
87
  # @!attribute [rw] tenants
91
88
  # @return [Array<Google::Cloud::Talent::V4beta1::Tenant>]
@@ -88,11 +88,13 @@ module Google
88
88
  # 01:30 UTC on January 15, 2017.
89
89
  #
90
90
  # In JavaScript, one can convert a Date object to this format using the
91
- # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
91
+ # standard
92
+ # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
92
93
  # method. In Python, a standard `datetime.datetime` object can be converted
93
- # to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
94
- # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
95
- # can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
94
+ # to this format using
95
+ # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
96
+ # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
97
+ # the Joda Time's [`ISODateTimeFormat.dateTime()`](
96
98
  # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
97
99
  # ) to obtain a formatter capable of generating timestamps in this format.
98
100
  # @!attribute [rw] seconds
@@ -5,6 +5,7 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/field_behavior_pb'
8
9
  require 'google/protobuf/timestamp_pb'
9
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
11
  add_message "google.cloud.talent.v4beta1.ClientEvent" do
@@ -224,10 +224,8 @@ module Google
224
224
  # Required. Resource name of the tenant under which the event is created.
225
225
  #
226
226
  # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
227
- # "projects/api-test-project/tenant/foo".
228
- #
229
- # Tenant id is optional and a default tenant is created if unspecified, for
230
- # example, "projects/api-test-project".
227
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
228
+ # is created, for example, "projects/foo".
231
229
  # @param client_event [Google::Cloud::Talent::V4beta1::ClientEvent | Hash]
232
230
  # Required. Events issued when end user interacts with customer's application
233
231
  # that uses Cloud Talent Solution.
@@ -6,6 +6,7 @@ require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
8
  require 'google/api/client_pb'
9
+ require 'google/api/field_behavior_pb'
9
10
  require 'google/cloud/talent/v4beta1/event_pb'
10
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
11
12
  add_message "google.cloud.talent.v4beta1.CreateClientEventRequest" do
@@ -5,6 +5,7 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/field_behavior_pb'
8
9
  require 'google/cloud/talent/v4beta1/common_pb'
9
10
  require 'google/protobuf/duration_pb'
10
11
  require 'google/protobuf/timestamp_pb'
@@ -43,6 +44,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
43
44
  repeated :application_job_filters, :message, 13, "google.cloud.talent.v4beta1.ApplicationJobFilter"
44
45
  optional :custom_attribute_filter, :string, 15
45
46
  optional :candidate_availability_filter, :message, 16, "google.cloud.talent.v4beta1.CandidateAvailabilityFilter"
47
+ repeated :availability_filters, :message, 18, "google.cloud.talent.v4beta1.AvailabilityFilter"
46
48
  repeated :person_name_filters, :message, 17, "google.cloud.talent.v4beta1.PersonNameFilter"
47
49
  end
48
50
  add_message "google.cloud.talent.v4beta1.LocationFilter" do
@@ -141,6 +143,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
141
143
  add_message "google.cloud.talent.v4beta1.CandidateAvailabilityFilter" do
142
144
  optional :negated, :bool, 1
143
145
  end
146
+ add_message "google.cloud.talent.v4beta1.AvailabilityFilter" do
147
+ optional :signal_type, :enum, 1, "google.cloud.talent.v4beta1.AvailabilitySignalType"
148
+ optional :range, :message, 2, "google.cloud.talent.v4beta1.TimestampRange"
149
+ optional :required, :bool, 3
150
+ end
144
151
  add_message "google.cloud.talent.v4beta1.PersonNameFilter" do
145
152
  optional :person_name, :string, 1
146
153
  end
@@ -170,6 +177,7 @@ module Google
170
177
  TimeFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.talent.v4beta1.TimeFilter").msgclass
171
178
  TimeFilter::TimeField = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.talent.v4beta1.TimeFilter.TimeField").enummodule
172
179
  CandidateAvailabilityFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.talent.v4beta1.CandidateAvailabilityFilter").msgclass
180
+ AvailabilityFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.talent.v4beta1.AvailabilityFilter").msgclass
173
181
  PersonNameFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.talent.v4beta1.PersonNameFilter").msgclass
174
182
  end
175
183
  end
@@ -5,6 +5,7 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/field_behavior_pb'
8
9
  require 'google/cloud/talent/v4beta1/common_pb'
9
10
  require 'google/protobuf/timestamp_pb'
10
11
  require 'google/type/postal_address_pb'
@@ -400,11 +400,9 @@ module Google
400
400
  # @param parent [String]
401
401
  # Required. The resource name of the tenant under which the job is created.
402
402
  #
403
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
404
- # "projects/api-test-project/tenant/foo".
405
- #
406
- # Tenant id is optional and a default tenant is created if unspecified, for
407
- # example, "projects/api-test-project".
403
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
404
+ # "projects/foo/tenant/bar". If tenant id is unspecified a default tenant
405
+ # is created. For example, "projects/foo".
408
406
  # @param job [Google::Cloud::Talent::V4beta1::Job | Hash]
409
407
  # Required. The Job to be created.
410
408
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::Job`
@@ -447,11 +445,11 @@ module Google
447
445
  # Required. The resource name of the job to retrieve.
448
446
  #
449
447
  # The format is
450
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
451
- # example, "projects/api-test-project/tenants/foo/jobs/1234".
448
+ # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For
449
+ # example, "projects/foo/tenants/bar/jobs/baz".
452
450
  #
453
- # Tenant id is optional and the default tenant is used if unspecified, for
454
- # example, "projects/api-test-project/jobs/1234".
451
+ # If tenant id is unspecified, the default tenant is used. For
452
+ # example, "projects/foo/jobs/bar".
455
453
  # @param options [Google::Gax::CallOptions]
456
454
  # Overrides the default settings for this call, e.g, timeout,
457
455
  # retries, etc.
@@ -488,8 +486,7 @@ module Google
488
486
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::Job`
489
487
  # can also be provided.
490
488
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
491
- # Optional but strongly recommended to be provided for the best service
492
- # experience.
489
+ # Strongly recommended for the best service experience.
493
490
  #
494
491
  # If {Google::Cloud::Talent::V4beta1::UpdateJobRequest#update_mask update_mask}
495
492
  # is provided, only the specified fields in
@@ -539,11 +536,11 @@ module Google
539
536
  # Required. The resource name of the job to be deleted.
540
537
  #
541
538
  # The format is
542
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
543
- # example, "projects/api-test-project/tenants/foo/jobs/1234".
539
+ # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For
540
+ # example, "projects/foo/tenants/bar/jobs/baz".
544
541
  #
545
- # Tenant id is optional and the default tenant is used if unspecified, for
546
- # example, "projects/api-test-project/jobs/1234".
542
+ # If tenant id is unspecified, the default tenant is used. For
543
+ # example, "projects/foo/jobs/bar".
547
544
  # @param options [Google::Gax::CallOptions]
548
545
  # Overrides the default settings for this call, e.g, timeout,
549
546
  # retries, etc.
@@ -575,11 +572,9 @@ module Google
575
572
  # @param parent [String]
576
573
  # Required. The resource name of the tenant under which the job is created.
577
574
  #
578
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
579
- # "projects/api-test-project/tenant/foo".
580
- #
581
- # Tenant id is optional and the default tenant is used if unspecified, for
582
- # example, "projects/api-test-project".
575
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
576
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
577
+ # is created. For example, "projects/foo".
583
578
  # @param filter [String]
584
579
  # Required. The filter string specifies the jobs to be enumerated.
585
580
  #
@@ -588,16 +583,16 @@ module Google
588
583
  # The fields eligible for filtering are:
589
584
  #
590
585
  # * `companyName` (Required)
591
- # * `requisitionId` (Optional)
592
- # * `status` (Optional) Available values: OPEN, EXPIRED, ALL. Defaults to
586
+ # * `requisitionId`
587
+ # * `status` Available values: OPEN, EXPIRED, ALL. Defaults to
593
588
  # OPEN if no value is specified.
594
589
  #
595
590
  # Sample Query:
596
591
  #
597
- # * companyName = "projects/api-test-project/tenants/foo/companies/bar"
598
- # * companyName = "projects/api-test-project/tenants/foo/companies/bar" AND
592
+ # * companyName = "projects/foo/tenants/bar/companies/baz"
593
+ # * companyName = "projects/foo/tenants/bar/companies/baz" AND
599
594
  # requisitionId = "req-1"
600
- # * companyName = "projects/api-test-project/tenants/foo/companies/bar" AND
595
+ # * companyName = "projects/foo/tenants/bar/companies/baz" AND
601
596
  # status = "EXPIRED"
602
597
  # @param page_size [Integer]
603
598
  # The maximum number of resources contained in the underlying API
@@ -606,7 +601,7 @@ module Google
606
601
  # performed per-page, this determines the maximum number of
607
602
  # resources in a page.
608
603
  # @param job_view [Google::Cloud::Talent::V4beta1::JobView]
609
- # Optional. The desired job attributes returned for jobs in the
604
+ # The desired job attributes returned for jobs in the
610
605
  # search response. Defaults to
611
606
  # {Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_FULL JobView::JOB_VIEW_FULL}
612
607
  # if no value is specified.
@@ -666,11 +661,9 @@ module Google
666
661
  # @param parent [String]
667
662
  # Required. The resource name of the tenant under which the job is created.
668
663
  #
669
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
670
- # "projects/api-test-project/tenant/foo".
671
- #
672
- # Tenant id is optional and the default tenant is used if unspecified, for
673
- # example, "projects/api-test-project".
664
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
665
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
666
+ # is created. For example, "projects/foo".
674
667
  # @param filter [String]
675
668
  # Required. The filter string specifies the jobs to be deleted.
676
669
  #
@@ -681,7 +674,7 @@ module Google
681
674
  # * `companyName` (Required)
682
675
  # * `requisitionId` (Required)
683
676
  #
684
- # Sample Query: companyName = "projects/api-test-project/companies/123" AND
677
+ # Sample Query: companyName = "projects/foo/companies/bar" AND
685
678
  # requisitionId = "req-1"
686
679
  # @param options [Google::Gax::CallOptions]
687
680
  # Overrides the default settings for this call, e.g, timeout,
@@ -725,11 +718,9 @@ module Google
725
718
  # @param parent [String]
726
719
  # Required. The resource name of the tenant to search within.
727
720
  #
728
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
729
- # "projects/api-test-project/tenant/foo".
730
- #
731
- # Tenant id is optional and the default tenant is used if unspecified, for
732
- # example, "projects/api-test-project".
721
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
722
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
723
+ # is created. For example, "projects/foo".
733
724
  # @param request_metadata [Google::Cloud::Talent::V4beta1::RequestMetadata | Hash]
734
725
  # Required. The meta information collected about the job searcher, used to
735
726
  # improve the search quality of the service. The identifiers (such as
@@ -737,24 +728,23 @@ module Google
737
728
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::RequestMetadata`
738
729
  # can also be provided.
739
730
  # @param search_mode [Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode]
740
- # Optional. Mode of a search.
731
+ # Mode of a search.
741
732
  #
742
733
  # Defaults to
743
734
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode::JOB_SEARCH}.
744
735
  # @param job_query [Google::Cloud::Talent::V4beta1::JobQuery | Hash]
745
- # Optional. Query used to search against jobs, such as keyword, location
746
- # filters, etc.
736
+ # Query used to search against jobs, such as keyword, location filters, etc.
747
737
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::JobQuery`
748
738
  # can also be provided.
749
739
  # @param enable_broadening [true, false]
750
- # Optional. Controls whether to broaden the search when it produces sparse
751
- # results. Broadened queries append results to the end of the matching
752
- # results list.
740
+ # Controls whether to broaden the search when it produces sparse results.
741
+ # Broadened queries append results to the end of the matching results
742
+ # list.
753
743
  #
754
744
  # Defaults to false.
755
745
  # @param require_precise_result_size [true, false]
756
- # Optional. Controls if the search job request requires the return of a
757
- # precise count of the first 300 results. Setting this to `true` ensures
746
+ # Controls if the search job request requires the return of a precise
747
+ # count of the first 300 results. Setting this to `true` ensures
758
748
  # consistency in the number of results per page. Best practice is to set this
759
749
  # value to true if a client allows users to jump directly to a
760
750
  # non-sequential search results page.
@@ -763,8 +753,7 @@ module Google
763
753
  #
764
754
  # Defaults to false.
765
755
  # @param histogram_queries [Array<Google::Cloud::Talent::V4beta1::HistogramQuery | Hash>]
766
- # Optional. An expression specifies a histogram request against matching
767
- # jobs.
756
+ # An expression specifies a histogram request against matching jobs.
768
757
  #
769
758
  # Expression syntax is an aggregation function call with histogram facets and
770
759
  # other options.
@@ -874,13 +863,13 @@ module Google
874
863
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::HistogramQuery`
875
864
  # can also be provided.
876
865
  # @param job_view [Google::Cloud::Talent::V4beta1::JobView]
877
- # Optional. The desired job attributes returned for jobs in the search
878
- # response. Defaults to
866
+ # The desired job attributes returned for jobs in the search response.
867
+ # Defaults to
879
868
  # {Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_SMALL JobView::JOB_VIEW_SMALL}
880
869
  # if no value is specified.
881
870
  # @param offset [Integer]
882
- # Optional. An integer that specifies the current offset (that is, starting
883
- # result location, amongst the jobs deemed by the API as relevant) in search
871
+ # An integer that specifies the current offset (that is, starting result
872
+ # location, amongst the jobs deemed by the API as relevant) in search
884
873
  # results. This field is only considered if
885
874
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#page_token page_token} is
886
875
  # unset.
@@ -896,8 +885,7 @@ module Google
896
885
  # performed per-page, this determines the maximum number of
897
886
  # resources in a page.
898
887
  # @param order_by [String]
899
- # Optional. The criteria determining how search results are sorted. Default
900
- # is
888
+ # The criteria determining how search results are sorted. Default is
901
889
  # `"relevance desc"`.
902
890
  #
903
891
  # Supported options are:
@@ -952,8 +940,8 @@ module Google
952
940
  # still applied unless explicitly disabled in
953
941
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#diversification_level diversification_level}.
954
942
  # @param diversification_level [Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel]
955
- # Optional. Controls whether highly similar jobs are returned next to each
956
- # other in the search results. Jobs are identified as highly similar based on
943
+ # Controls whether highly similar jobs are returned next to each other in
944
+ # the search results. Jobs are identified as highly similar based on
957
945
  # their titles, job categories, and locations. Highly similar results are
958
946
  # clustered so that only one representative job of the cluster is
959
947
  # displayed to the job seeker higher up in the results, with the other jobs
@@ -963,12 +951,12 @@ module Google
963
951
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel::SIMPLE}
964
952
  # if no value is specified.
965
953
  # @param custom_ranking_info [Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo | Hash]
966
- # Optional. Controls over how job documents get ranked on top of existing
967
- # relevance score (determined by API algorithm).
954
+ # Controls over how job documents get ranked on top of existing relevance
955
+ # score (determined by API algorithm).
968
956
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo`
969
957
  # can also be provided.
970
958
  # @param disable_keyword_match [true, false]
971
- # Optional. Controls whether to disable exact keyword match on
959
+ # Controls whether to disable exact keyword match on
972
960
  # {Google::Cloud::Talent::V4beta1::Job#title Job#title},
973
961
  # {Google::Cloud::Talent::V4beta1::Job#description Job#description},
974
962
  # {Google::Cloud::Talent::V4beta1::Job#company_display_name Job#company_display_name},
@@ -1079,11 +1067,9 @@ module Google
1079
1067
  # @param parent [String]
1080
1068
  # Required. The resource name of the tenant to search within.
1081
1069
  #
1082
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
1083
- # "projects/api-test-project/tenant/foo".
1084
- #
1085
- # Tenant id is optional and the default tenant is used if unspecified, for
1086
- # example, "projects/api-test-project".
1070
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
1071
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
1072
+ # is created. For example, "projects/foo".
1087
1073
  # @param request_metadata [Google::Cloud::Talent::V4beta1::RequestMetadata | Hash]
1088
1074
  # Required. The meta information collected about the job searcher, used to
1089
1075
  # improve the search quality of the service. The identifiers (such as
@@ -1091,24 +1077,23 @@ module Google
1091
1077
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::RequestMetadata`
1092
1078
  # can also be provided.
1093
1079
  # @param search_mode [Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode]
1094
- # Optional. Mode of a search.
1080
+ # Mode of a search.
1095
1081
  #
1096
1082
  # Defaults to
1097
1083
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode::JOB_SEARCH}.
1098
1084
  # @param job_query [Google::Cloud::Talent::V4beta1::JobQuery | Hash]
1099
- # Optional. Query used to search against jobs, such as keyword, location
1100
- # filters, etc.
1085
+ # Query used to search against jobs, such as keyword, location filters, etc.
1101
1086
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::JobQuery`
1102
1087
  # can also be provided.
1103
1088
  # @param enable_broadening [true, false]
1104
- # Optional. Controls whether to broaden the search when it produces sparse
1105
- # results. Broadened queries append results to the end of the matching
1106
- # results list.
1089
+ # Controls whether to broaden the search when it produces sparse results.
1090
+ # Broadened queries append results to the end of the matching results
1091
+ # list.
1107
1092
  #
1108
1093
  # Defaults to false.
1109
1094
  # @param require_precise_result_size [true, false]
1110
- # Optional. Controls if the search job request requires the return of a
1111
- # precise count of the first 300 results. Setting this to `true` ensures
1095
+ # Controls if the search job request requires the return of a precise
1096
+ # count of the first 300 results. Setting this to `true` ensures
1112
1097
  # consistency in the number of results per page. Best practice is to set this
1113
1098
  # value to true if a client allows users to jump directly to a
1114
1099
  # non-sequential search results page.
@@ -1117,8 +1102,7 @@ module Google
1117
1102
  #
1118
1103
  # Defaults to false.
1119
1104
  # @param histogram_queries [Array<Google::Cloud::Talent::V4beta1::HistogramQuery | Hash>]
1120
- # Optional. An expression specifies a histogram request against matching
1121
- # jobs.
1105
+ # An expression specifies a histogram request against matching jobs.
1122
1106
  #
1123
1107
  # Expression syntax is an aggregation function call with histogram facets and
1124
1108
  # other options.
@@ -1228,13 +1212,13 @@ module Google
1228
1212
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::HistogramQuery`
1229
1213
  # can also be provided.
1230
1214
  # @param job_view [Google::Cloud::Talent::V4beta1::JobView]
1231
- # Optional. The desired job attributes returned for jobs in the search
1232
- # response. Defaults to
1215
+ # The desired job attributes returned for jobs in the search response.
1216
+ # Defaults to
1233
1217
  # {Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_SMALL JobView::JOB_VIEW_SMALL}
1234
1218
  # if no value is specified.
1235
1219
  # @param offset [Integer]
1236
- # Optional. An integer that specifies the current offset (that is, starting
1237
- # result location, amongst the jobs deemed by the API as relevant) in search
1220
+ # An integer that specifies the current offset (that is, starting result
1221
+ # location, amongst the jobs deemed by the API as relevant) in search
1238
1222
  # results. This field is only considered if
1239
1223
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#page_token page_token} is
1240
1224
  # unset.
@@ -1250,8 +1234,7 @@ module Google
1250
1234
  # performed per-page, this determines the maximum number of
1251
1235
  # resources in a page.
1252
1236
  # @param order_by [String]
1253
- # Optional. The criteria determining how search results are sorted. Default
1254
- # is
1237
+ # The criteria determining how search results are sorted. Default is
1255
1238
  # `"relevance desc"`.
1256
1239
  #
1257
1240
  # Supported options are:
@@ -1306,8 +1289,8 @@ module Google
1306
1289
  # still applied unless explicitly disabled in
1307
1290
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#diversification_level diversification_level}.
1308
1291
  # @param diversification_level [Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel]
1309
- # Optional. Controls whether highly similar jobs are returned next to each
1310
- # other in the search results. Jobs are identified as highly similar based on
1292
+ # Controls whether highly similar jobs are returned next to each other in
1293
+ # the search results. Jobs are identified as highly similar based on
1311
1294
  # their titles, job categories, and locations. Highly similar results are
1312
1295
  # clustered so that only one representative job of the cluster is
1313
1296
  # displayed to the job seeker higher up in the results, with the other jobs
@@ -1317,12 +1300,12 @@ module Google
1317
1300
  # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel::SIMPLE}
1318
1301
  # if no value is specified.
1319
1302
  # @param custom_ranking_info [Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo | Hash]
1320
- # Optional. Controls over how job documents get ranked on top of existing
1321
- # relevance score (determined by API algorithm).
1303
+ # Controls over how job documents get ranked on top of existing relevance
1304
+ # score (determined by API algorithm).
1322
1305
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo`
1323
1306
  # can also be provided.
1324
1307
  # @param disable_keyword_match [true, false]
1325
- # Optional. Controls whether to disable exact keyword match on
1308
+ # Controls whether to disable exact keyword match on
1326
1309
  # {Google::Cloud::Talent::V4beta1::Job#title Job#title},
1327
1310
  # {Google::Cloud::Talent::V4beta1::Job#description Job#description},
1328
1311
  # {Google::Cloud::Talent::V4beta1::Job#company_display_name Job#company_display_name},
@@ -1422,11 +1405,9 @@ module Google
1422
1405
  # @param parent [String]
1423
1406
  # Required. The resource name of the tenant under which the job is created.
1424
1407
  #
1425
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
1426
- # "projects/api-test-project/tenant/foo".
1427
- #
1428
- # Tenant id is optional and a default tenant is created if unspecified, for
1429
- # example, "projects/api-test-project".
1408
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
1409
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
1410
+ # is created. For example, "projects/foo".
1430
1411
  # @param jobs [Array<Google::Cloud::Talent::V4beta1::Job | Hash>]
1431
1412
  # Required. The jobs to be created.
1432
1413
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::Job`
@@ -1497,18 +1478,16 @@ module Google
1497
1478
  # @param parent [String]
1498
1479
  # Required. The resource name of the tenant under which the job is created.
1499
1480
  #
1500
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
1501
- # "projects/api-test-project/tenant/foo".
1502
- #
1503
- # Tenant id is optional and the default tenant is used if unspecified, for
1504
- # example, "projects/api-test-project".
1481
+ # The format is "projects/{project_id}/tenants/{tenant_id}". For example,
1482
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
1483
+ # is created. For example, "projects/foo".
1505
1484
  # @param jobs [Array<Google::Cloud::Talent::V4beta1::Job | Hash>]
1506
- # Required. The jobs to be updated.
1485
+ # The jobs to be updated.
1507
1486
  # A hash of the same form as `Google::Cloud::Talent::V4beta1::Job`
1508
1487
  # can also be provided.
1509
1488
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
1510
- # Optional but strongly recommended to be provided for the best service
1511
- # experience, also increase latency when checking status of batch operation.
1489
+ # Strongly recommended for the best service experience. Be aware that it will
1490
+ # also increase latency when checking the status of a batch operation.
1512
1491
  #
1513
1492
  # If
1514
1493
  # {Google::Cloud::Talent::V4beta1::BatchUpdateJobsRequest#update_mask update_mask}