google-cloud-talent 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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,10 +23,8 @@ module Google
23
23
  # Required. Resource name of the tenant under which the company is created.
24
24
  #
25
25
  # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
26
- # "projects/api-test-project/tenant/foo".
27
- #
28
- # Tenant id is optional and a default tenant is created if unspecified, for
29
- # example, "projects/api-test-project".
26
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
27
+ # is created, for example, "projects/foo".
30
28
  # @!attribute [rw] company
31
29
  # @return [Google::Cloud::Talent::V4beta1::Company]
32
30
  # Required. The company to be created.
@@ -41,7 +39,7 @@ module Google
41
39
  # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
42
40
  # example, "projects/api-test-project/tenants/foo/companies/bar".
43
41
  #
44
- # Tenant id is optional and the default tenant is used if unspecified, for
42
+ # If tenant id is unspecified, the default tenant is used, for
45
43
  # example, "projects/api-test-project/companies/bar".
46
44
  class GetCompanyRequest; end
47
45
 
@@ -52,8 +50,7 @@ module Google
52
50
  # system.
53
51
  # @!attribute [rw] update_mask
54
52
  # @return [Google::Protobuf::FieldMask]
55
- # Optional but strongly recommended for the best service
56
- # experience.
53
+ # Strongly recommended for the best service experience.
57
54
  #
58
55
  # If
59
56
  # {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#update_mask update_mask}
@@ -73,10 +70,10 @@ module Google
73
70
  #
74
71
  # The format is
75
72
  # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
76
- # example, "projects/api-test-project/tenants/foo/companies/bar".
73
+ # example, "projects/foo/tenants/bar/companies/baz".
77
74
  #
78
- # Tenant id is optional and the default tenant is used if unspecified, for
79
- # example, "projects/api-test-project/companies/bar".
75
+ # If tenant id is unspecified, the default tenant is used, for
76
+ # example, "projects/foo/companies/bar".
80
77
  class DeleteCompanyRequest; end
81
78
 
82
79
  # List companies for which the client has ACL visibility.
@@ -85,20 +82,20 @@ module Google
85
82
  # Required. Resource name of the tenant under which the company is created.
86
83
  #
87
84
  # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
88
- # "projects/api-test-project/tenant/foo".
85
+ # "projects/foo/tenant/bar".
89
86
  #
90
- # Tenant id is optional and the default tenant is used if unspecified, for
91
- # example, "projects/api-test-project".
87
+ # If tenant id is unspecified, the default tenant will be used, for
88
+ # example, "projects/foo".
92
89
  # @!attribute [rw] page_token
93
90
  # @return [String]
94
- # Optional. The starting indicator from which to return results.
91
+ # The starting indicator from which to return results.
95
92
  # @!attribute [rw] page_size
96
93
  # @return [Integer]
97
- # Optional. The maximum number of companies to be returned, at most 100.
94
+ # The maximum number of companies to be returned, at most 100.
98
95
  # Default is 100 if a non-positive number is provided.
99
96
  # @!attribute [rw] require_open_jobs
100
97
  # @return [true, false]
101
- # Optional. Set to true if the companies requested must have open jobs.
98
+ # Set to true if the companies requested must have open jobs.
102
99
  #
103
100
  # Defaults to false.
104
101
  #
@@ -107,8 +104,6 @@ module Google
107
104
  # companies are fetched, among which only those with open jobs are returned.
108
105
  class ListCompaniesRequest; end
109
106
 
110
- # Output only.
111
- #
112
107
  # The List companies response object.
113
108
  # @!attribute [rw] companies
114
109
  # @return [Array<Google::Cloud::Talent::V4beta1::Company>]
@@ -17,18 +17,16 @@ module Google
17
17
  module Cloud
18
18
  module Talent
19
19
  module V4beta1
20
- # Input only.
21
- #
22
20
  # Auto-complete parameters.
23
21
  # @!attribute [rw] parent
24
22
  # @return [String]
25
23
  # Required. Resource name of tenant the completion is performed within.
26
24
  #
27
25
  # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
28
- # "projects/api-test-project/tenant/foo".
26
+ # "projects/foo/tenant/bar".
29
27
  #
30
- # Tenant id is optional and the default tenant is used if unspecified, for
31
- # example, "projects/api-test-project".
28
+ # If tenant id is unspecified, the default tenant is used, for
29
+ # example, "projects/foo".
32
30
  # @!attribute [rw] query
33
31
  # @return [String]
34
32
  # Required. The query used to generate suggestions.
@@ -36,7 +34,7 @@ module Google
36
34
  # The maximum number of allowed characters is 255.
37
35
  # @!attribute [rw] language_codes
38
36
  # @return [Array<String>]
39
- # Optional. The list of languages of the query. This is
37
+ # The list of languages of the query. This is
40
38
  # the BCP-47 language code, such as "en-US" or "sr-Latn".
41
39
  # For more information, see
42
40
  # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
@@ -69,21 +67,21 @@ module Google
69
67
  # The maximum allowed page size is 10.
70
68
  # @!attribute [rw] company
71
69
  # @return [String]
72
- # Optional. If provided, restricts completion to specified company.
70
+ # If provided, restricts completion to specified company.
73
71
  #
74
72
  # The format is
75
73
  # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
76
- # example, "projects/api-test-project/tenants/foo/companies/bar".
74
+ # example, "projects/foo/tenants/bar/companies/baz".
77
75
  #
78
- # Tenant id is optional and the default tenant is used if unspecified, for
79
- # example, "projects/api-test-project/companies/bar".
76
+ # If tenant id is unspecified, the default tenant is used, for
77
+ # example, "projects/foo".
80
78
  # @!attribute [rw] scope
81
79
  # @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope]
82
- # Optional. The scope of the completion. The defaults is
80
+ # The scope of the completion. The defaults is
83
81
  # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope::PUBLIC}.
84
82
  # @!attribute [rw] type
85
83
  # @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType]
86
- # Optional. The completion topic. The default is
84
+ # The completion topic. The default is
87
85
  # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}.
88
86
  class CompleteQueryRequest
89
87
  # Enum to specify the scope of completion.
@@ -115,8 +113,6 @@ module Google
115
113
  end
116
114
  end
117
115
 
118
- # Output only.
119
- #
120
116
  # Response of auto-complete query.
121
117
  # @!attribute [rw] completion_results
122
118
  # @return [Array<Google::Cloud::Talent::V4beta1::CompleteQueryResponse::CompletionResult>]
@@ -126,8 +122,6 @@ module Google
126
122
  # Additional information for the API invocation, such as the request
127
123
  # tracking id.
128
124
  class CompleteQueryResponse
129
- # Output only.
130
- #
131
125
  # Resource that represents completion results.
132
126
  # @!attribute [rw] suggestion
133
127
  # @return [String]
@@ -24,7 +24,7 @@ module Google
24
24
  # with other calls, such as job searches, issued to the service by the client.
25
25
  # @!attribute [rw] request_id
26
26
  # @return [String]
27
- # Optional but highly recommended.
27
+ # Strongly recommended for the best service experience.
28
28
  #
29
29
  # A unique ID generated in the API responses. It can be found in
30
30
  # {Google::Cloud::Talent::V4beta1::ResponseMetadata#request_id ResponseMetadata#request_id}.
@@ -44,8 +44,8 @@ module Google
44
44
  # that implements Cloud Talent Solution.
45
45
  # @!attribute [rw] event_notes
46
46
  # @return [String]
47
- # Optional. Notes about the event provided by recruiters or other users, for
48
- # example, feedback on why a profile was bookmarked.
47
+ # Notes about the event provided by recruiters or other users, for example,
48
+ # feedback on why a profile was bookmarked.
49
49
  class ClientEvent; end
50
50
 
51
51
  # An event issued when a job seeker interacts with the application that
@@ -66,15 +66,15 @@ module Google
66
66
  #
67
67
  # The format is
68
68
  # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
69
- # example, "projects/api-test-project/tenants/foo/jobs/1234".
69
+ # example, "projects/foo/tenants/bar/jobs/baz".
70
70
  # @!attribute [rw] profile
71
71
  # @return [String]
72
- # Optional. The {Google::Cloud::Talent::V4beta1::Profile#name profile name}
73
- # associated with this client event.
72
+ # The {Google::Cloud::Talent::V4beta1::Profile#name profile name} associated
73
+ # with this client event.
74
74
  #
75
75
  # The format is
76
76
  # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
77
- # for example, "projects/api-test-project/tenants/foo/profiles/bar".
77
+ # for example, "projects/foo/tenants/bar/profiles/baz".
78
78
  class JobEvent
79
79
  # An enumeration of an event attributed to the behavior of the end user,
80
80
  # such as a job seeker.
@@ -189,16 +189,15 @@ module Google
189
189
  #
190
190
  # The format is
191
191
  # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
192
- # for example, "projects/api-test-project/tenants/foo/profiles/bar".
192
+ # for example, "projects/foo/tenants/bar/profiles/baz".
193
193
  # @!attribute [rw] jobs
194
194
  # @return [Array<String>]
195
- # Optional. The {Google::Cloud::Talent::V4beta1::Job#name job name(s)}
196
- # associated with this client event. Leave it empty if the event isn't
197
- # associated with a job.
195
+ # The {Google::Cloud::Talent::V4beta1::Job#name job name(s)} associated with
196
+ # this client event. Leave it empty if the event isn't associated with a job.
198
197
  #
199
198
  # The format is
200
199
  # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
201
- # example, "projects/api-test-project/tenants/foo/jobs/1234".
200
+ # example, "projects/foo/tenants/bar/jobs/baz".
202
201
  class ProfileEvent
203
202
  # The enum represents types of client events for a candidate profile.
204
203
  module ProfileEventType
@@ -23,10 +23,8 @@ module Google
23
23
  # Required. Resource name of the tenant under which the event is created.
24
24
  #
25
25
  # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
26
- # "projects/api-test-project/tenant/foo".
27
- #
28
- # Tenant id is optional and a default tenant is created if unspecified, for
29
- # example, "projects/api-test-project".
26
+ # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
27
+ # is created, for example, "projects/foo".
30
28
  # @!attribute [rw] client_event
31
29
  # @return [Google::Cloud::Talent::V4beta1::ClientEvent]
32
30
  # Required. Events issued when end user interacts with customer's application
@@ -17,18 +17,16 @@ module Google
17
17
  module Cloud
18
18
  module Talent
19
19
  module V4beta1
20
- # Input only.
21
- #
22
20
  # The query required to perform a search query.
23
21
  # @!attribute [rw] query
24
22
  # @return [String]
25
- # Optional. The query string that matches against the job title, description,
26
- # and location fields.
23
+ # The query string that matches against the job title, description, and
24
+ # location fields.
27
25
  #
28
26
  # The maximum number of allowed characters is 255.
29
27
  # @!attribute [rw] companies
30
28
  # @return [Array<String>]
31
- # Optional. This filter specifies the company entities to search against.
29
+ # This filter specifies the company entities to search against.
32
30
  #
33
31
  # If a value isn't specified, jobs are searched for against all
34
32
  # companies.
@@ -37,16 +35,16 @@ module Google
37
35
  # companies specified.
38
36
  #
39
37
  # The format is
40
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
41
- # example, "projects/api-test-project/tenants/foo/companies/bar".
38
+ # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For
39
+ # example, "projects/foo/tenants/bar/companies/baz".
42
40
  #
43
- # Tenant id is optional and the default tenant is used if unspecified, for
44
- # example, "projects/api-test-project/companies/bar".
41
+ # If tenant id is unspecified, the default tenant is used. For
42
+ # example, "projects/foo/companies/bar".
45
43
  #
46
44
  # At most 20 company filters are allowed.
47
45
  # @!attribute [rw] location_filters
48
46
  # @return [Array<Google::Cloud::Talent::V4beta1::LocationFilter>]
49
- # Optional. The location filter specifies geo-regions containing the jobs to
47
+ # The location filter specifies geo-regions containing the jobs to
50
48
  # search against. See
51
49
  # {Google::Cloud::Talent::V4beta1::LocationFilter LocationFilter} for more
52
50
  # information.
@@ -62,9 +60,9 @@ module Google
62
60
  # At most 5 location filters are allowed.
63
61
  # @!attribute [rw] job_categories
64
62
  # @return [Array<Google::Cloud::Talent::V4beta1::JobCategory>]
65
- # Optional. The category filter specifies the categories of jobs to search
66
- # against. See {Google::Cloud::Talent::V4beta1::JobCategory JobCategory} for
67
- # more information.
63
+ # The category filter specifies the categories of jobs to search against.
64
+ # See {Google::Cloud::Talent::V4beta1::JobCategory JobCategory} for more
65
+ # information.
68
66
  #
69
67
  # If a value isn't specified, jobs from any category are searched against.
70
68
  #
@@ -72,8 +70,7 @@ module Google
72
70
  # categories are searched against.
73
71
  # @!attribute [rw] commute_filter
74
72
  # @return [Google::Cloud::Talent::V4beta1::CommuteFilter]
75
- # Optional. Allows filtering jobs by commute time with different travel
76
- # methods (for
73
+ # Allows filtering jobs by commute time with different travel methods (for
77
74
  # example, driving or public transit).
78
75
  #
79
76
  # Note: This only works when you specify a
@@ -84,7 +81,7 @@ module Google
84
81
  # Currently we don't support sorting by commute time.
85
82
  # @!attribute [rw] company_display_names
86
83
  # @return [Array<String>]
87
- # Optional. This filter specifies the exact company
84
+ # This filter specifies the exact company
88
85
  # {Google::Cloud::Talent::V4beta1::Company#display_name Company#display_name} of
89
86
  # the jobs to search against.
90
87
  #
@@ -97,14 +94,14 @@ module Google
97
94
  # At most 20 company display name filters are allowed.
98
95
  # @!attribute [rw] compensation_filter
99
96
  # @return [Google::Cloud::Talent::V4beta1::CompensationFilter]
100
- # Optional. This search filter is applied only to
97
+ # This search filter is applied only to
101
98
  # {Google::Cloud::Talent::V4beta1::Job#compensation_info Job#compensation_info}.
102
99
  # For example, if the filter is specified as "Hourly job with per-hour
103
100
  # compensation > $15", only jobs meeting these criteria are searched. If a
104
101
  # filter isn't defined, all open jobs are searched.
105
102
  # @!attribute [rw] custom_attribute_filter
106
103
  # @return [String]
107
- # Optional. This filter specifies a structured syntax to match against the
104
+ # This filter specifies a structured syntax to match against the
108
105
  # {Google::Cloud::Talent::V4beta1::Job#custom_attributes Job#custom_attributes}
109
106
  # marked as `filterable`.
110
107
  #
@@ -129,15 +126,15 @@ module Google
129
126
  # driving_years > 10`
130
127
  # @!attribute [rw] disable_spell_check
131
128
  # @return [true, false]
132
- # Optional. This flag controls the spell-check feature. If false, the
129
+ # This flag controls the spell-check feature. If false, the
133
130
  # service attempts to correct a misspelled query,
134
131
  # for example, "enginee" is corrected to "engineer".
135
132
  #
136
133
  # Defaults to false: a spell check is performed.
137
134
  # @!attribute [rw] employment_types
138
135
  # @return [Array<Google::Cloud::Talent::V4beta1::EmploymentType>]
139
- # Optional. The employment type filter specifies the employment type of jobs
140
- # to search against, such as
136
+ # The employment type filter specifies the employment type of jobs to
137
+ # search against, such as
141
138
  # {Google::Cloud::Talent::V4beta1::EmploymentType::FULL_TIME EmploymentType::FULL_TIME}.
142
139
  #
143
140
  # If a value isn't specified, jobs in the search results includes any
@@ -147,7 +144,7 @@ module Google
147
144
  # any of the specified employment types.
148
145
  # @!attribute [rw] language_codes
149
146
  # @return [Array<String>]
150
- # Optional. This filter specifies the locale of jobs to search against,
147
+ # This filter specifies the locale of jobs to search against,
151
148
  # for example, "en-US".
152
149
  #
153
150
  # If a value isn't specified, the search results can contain jobs in any
@@ -161,12 +158,11 @@ module Google
161
158
  # At most 10 language code filters are allowed.
162
159
  # @!attribute [rw] publish_time_range
163
160
  # @return [Google::Cloud::Talent::V4beta1::TimestampRange]
164
- # Optional. Jobs published within a range specified by this filter are
165
- # searched against.
161
+ # Jobs published within a range specified by this filter are searched
162
+ # against.
166
163
  # @!attribute [rw] excluded_jobs
167
164
  # @return [Array<String>]
168
- # Optional. This filter specifies a list of job names to be excluded during
169
- # search.
165
+ # This filter specifies a list of job names to be excluded during search.
170
166
  #
171
167
  # At most 400 excluded job names are allowed.
172
168
  class JobQuery; end
@@ -174,32 +170,50 @@ module Google
174
170
  # Filters to apply when performing the search query.
175
171
  # @!attribute [rw] query
176
172
  # @return [String]
177
- # Optional. Keywords to match any text fields of profiles.
173
+ # Keywords to match any text fields of profiles.
178
174
  #
179
175
  # For example, "software engineer in Palo Alto".
180
176
  # @!attribute [rw] location_filters
181
177
  # @return [Array<Google::Cloud::Talent::V4beta1::LocationFilter>]
182
- # Optional. The location filter specifies geo-regions containing the profiles
183
- # to search against. It filters against all of a profile's
178
+ # The location filter specifies geo-regions containing the profiles to
179
+ # search against.
180
+ #
181
+ # One of
182
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#address LocationFilter#address}
183
+ # or
184
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#lat_lng LocationFilter#lat_lng}
185
+ # must be provided or an error is thrown. If both
186
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#address LocationFilter#address}
187
+ # and
188
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#lat_lng LocationFilter#lat_lng}
189
+ # are provided, an error is thrown.
190
+ #
191
+ # The following logic is used to determine which locations in
192
+ # the profile to filter against:
193
+ # 1. All of the profile's geocoded
184
194
  # {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses} where
185
195
  # {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is PERSONAL and
186
- # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is true. If
187
- # no such address exists, a fallback logic is applied in an attempt to
188
- # determine the profile's primary address.
189
- #
190
- # The fallback logic selects an address from a profile's
191
- # {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses} in the
192
- # following order of priority:
193
- # 1. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is PERSONAL
194
- # and {Google::Cloud::Talent::V4beta1::Address#current Address#current} is false
195
- # or not set.
196
- # 2. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is
196
+ # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is true.
197
+ # 2. If the above set of locations is empty, all of the profile's geocoded
198
+ # {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses} where
199
+ # {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is
197
200
  # CONTACT_INFO_USAGE_UNSPECIFIED and
198
201
  # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is true.
199
- # 3. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is
202
+ # 3. If the above set of locations is empty, all of the profile's geocoded
203
+ # {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses} where
204
+ # {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is PERSONAL or
200
205
  # CONTACT_INFO_USAGE_UNSPECIFIED and
201
- # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is false or
202
- # not set.
206
+ # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is not set.
207
+ #
208
+ # This means that any profiles without any
209
+ # {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses} that
210
+ # match any of the above criteria will not be included in a search with
211
+ # location filter. Furthermore, any
212
+ # {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses} where
213
+ # {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is WORK or
214
+ # SCHOOL or where
215
+ # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is false are
216
+ # not considered for location filter.
203
217
  #
204
218
  # If a location filter isn't specified, profiles fitting the other search
205
219
  # criteria are retrieved regardless of where they're located.
@@ -215,7 +229,7 @@ module Google
215
229
  # point (latitude and longitude), and radius are automatically detected by
216
230
  # the Google Maps Geocoding API and included as well. If
217
231
  # {Google::Cloud::Talent::V4beta1::LocationFilter#address LocationFilter#address}
218
- # is not recognized as a location, the filter falls back to keyword search.
232
+ # cannot be geocoded, the filter falls back to keyword search.
219
233
  #
220
234
  # If the detected
221
235
  # {Google::Cloud::Talent::V4beta1::Location::LocationType LocationType} is
@@ -223,31 +237,46 @@ module Google
223
237
  # {Google::Cloud::Talent::V4beta1::Location::LocationType::ADMINISTRATIVE_AREA LocationType::ADMINISTRATIVE_AREA},
224
238
  # or
225
239
  # {Google::Cloud::Talent::V4beta1::Location::LocationType::COUNTRY LocationType::COUNTRY},
226
- # or location is recognized but a radius can not be determined by the
227
- # geo-coder, the filter is performed against the detected location name
228
- # (using exact text matching). Otherwise, the filter is performed against the
229
- # detected center point and a radius. The largest value from among the
230
- # following options is automatically set as the radius value:
231
- # 1. 10 miles.
232
- # 2. Detected location radius +
240
+ # the filter is performed against the detected location name (using exact
241
+ # text matching). Otherwise, the filter is performed against the detected
242
+ # center point and a radius of detected location radius +
233
243
  # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}.
234
- # 3. If the detected
235
- # {Google::Cloud::Talent::V4beta1::Location::LocationType LocationType} is one of
236
- # {Google::Cloud::Talent::V4beta1::Location::LocationType::SUB_LOCALITY LocationType::SUB_LOCALITY},
237
- # {Google::Cloud::Talent::V4beta1::Location::LocationType::SUB_LOCALITY_2 LocationType::SUB_LOCALITY_2},
238
- # {Google::Cloud::Talent::V4beta1::Location::LocationType::NEIGHBORHOOD LocationType::NEIGHBORHOOD},
239
- # {Google::Cloud::Talent::V4beta1::Location::LocationType::POSTAL_CODE LocationType::POSTAL_CODE},
240
- # or
241
- # {Google::Cloud::Talent::V4beta1::Location::LocationType::STREET_ADDRESS LocationType::STREET_ADDRESS},
242
- # the following two values are calculated and the larger of the two is
243
- # compared to #1 and #2, above:
244
- # * Calculated radius of the city (from the city center) that contains the
245
- # geo-coded location.
246
- # * Distance from the city center (of the city containing the geo-coded
247
- # location) to the detected location center + 0.5 miles.
244
+ #
245
+ # If
246
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#address LocationFilter#address}
247
+ # is provided,
248
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
249
+ # is the additional radius on top of the radius of the location geocoded from
250
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#address LocationFilter#address}.
251
+ # If
252
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#lat_lng LocationFilter#lat_lng}
253
+ # is provided,
254
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
255
+ # is the only radius that is used.
256
+ #
257
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
258
+ # is 10 by default. Note that the value of
259
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
260
+ # is 0 if it is unset, so the server does not differentiate
261
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
262
+ # that is explicitly set to 0 and
263
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
264
+ # that is not set. Which means that if
265
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
266
+ # is explicitly set to 0, the server will use the default value of
267
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
268
+ # which is 10. To work around this and effectively set
269
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
270
+ # to 0, we recommend setting
271
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
272
+ # to a very small decimal number (such as 0.00001).
273
+ #
274
+ # If
275
+ # {Google::Cloud::Talent::V4beta1::LocationFilter#distance_in_miles LocationFilter#distance_in_miles}
276
+ # is negative, an error is thrown.
248
277
  # @!attribute [rw] job_title_filters
249
278
  # @return [Array<Google::Cloud::Talent::V4beta1::JobTitleFilter>]
250
- # Optional. Job title filter specifies job titles of profiles to match on.
279
+ # Job title filter specifies job titles of profiles to match on.
251
280
  #
252
281
  # If a job title isn't specified, profiles with any titles are retrieved.
253
282
  #
@@ -261,7 +290,7 @@ module Google
261
290
  # For example, search for profiles with a job title "Product Manager".
262
291
  # @!attribute [rw] employer_filters
263
292
  # @return [Array<Google::Cloud::Talent::V4beta1::EmployerFilter>]
264
- # Optional. Employer filter specifies employers of profiles to match on.
293
+ # Employer filter specifies employers of profiles to match on.
265
294
  #
266
295
  # If an employer filter isn't specified, profiles with any employers are
267
296
  # retrieved.
@@ -277,7 +306,7 @@ module Google
277
306
  # LLC".
278
307
  # @!attribute [rw] education_filters
279
308
  # @return [Array<Google::Cloud::Talent::V4beta1::EducationFilter>]
280
- # Optional. Education filter specifies education of profiles to match on.
309
+ # Education filter specifies education of profiles to match on.
281
310
  #
282
311
  # If an education filter isn't specified, profiles with any education are
283
312
  # retrieved.
@@ -292,7 +321,7 @@ module Google
292
321
  # For example, search for profiles with a master degree.
293
322
  # @!attribute [rw] skill_filters
294
323
  # @return [Array<Google::Cloud::Talent::V4beta1::SkillFilter>]
295
- # Optional. Skill filter specifies skill of profiles to match on.
324
+ # Skill filter specifies skill of profiles to match on.
296
325
  #
297
326
  # If a skill filter isn't specified, profiles with any skills are retrieved.
298
327
  #
@@ -306,8 +335,8 @@ module Google
306
335
  # list.
307
336
  # @!attribute [rw] work_experience_filter
308
337
  # @return [Array<Google::Cloud::Talent::V4beta1::WorkExperienceFilter>]
309
- # Optional. Work experience filter specifies the total working experience of
310
- # profiles to match on.
338
+ # Work experience filter specifies the total working experience of profiles
339
+ # to match on.
311
340
  #
312
341
  # If a work experience filter isn't specified, profiles with any
313
342
  # professional experience are retrieved.
@@ -318,29 +347,26 @@ module Google
318
347
  # For example, search for profiles with 10 years of work experience.
319
348
  # @!attribute [rw] time_filters
320
349
  # @return [Array<Google::Cloud::Talent::V4beta1::TimeFilter>]
321
- # Optional. Time filter specifies the create/update timestamp of the profiles
322
- # to match on.
350
+ # Time filter specifies the create/update timestamp of the profiles to match
351
+ # on.
323
352
  #
324
353
  # For example, search for profiles created since "2018-1-1".
325
354
  # @!attribute [rw] hirable_filter
326
355
  # @return [Google::Protobuf::BoolValue]
327
- # Optional. The hirable filter specifies the profile's hirable status to
328
- # match on.
356
+ # The hirable filter specifies the profile's hirable status to match on.
329
357
  # @!attribute [rw] application_date_filters
330
358
  # @return [Array<Google::Cloud::Talent::V4beta1::ApplicationDateFilter>]
331
- # Optional. The application date filters specify application date ranges to
332
- # match on.
359
+ # The application date filters specify application date ranges to match on.
333
360
  # @!attribute [rw] application_outcome_notes_filters
334
361
  # @return [Array<Google::Cloud::Talent::V4beta1::ApplicationOutcomeNotesFilter>]
335
- # Optional. The application outcome notes filters specify the notes for the
336
- # outcome of the job application.
362
+ # The application outcome notes filters specify the notes for the outcome of
363
+ # the job application.
337
364
  # @!attribute [rw] application_job_filters
338
365
  # @return [Array<Google::Cloud::Talent::V4beta1::ApplicationJobFilter>]
339
- # Optional. The application job filters specify the job applied for in the
340
- # application.
366
+ # The application job filters specify the job applied for in the application.
341
367
  # @!attribute [rw] custom_attribute_filter
342
368
  # @return [String]
343
- # Optional. This filter specifies a structured syntax to match against the
369
+ # This filter specifies a structured syntax to match against the
344
370
  # {Google::Cloud::Talent::V4beta1::Profile#custom_attributes Profile#custom_attributes}
345
371
  # that are marked as `filterable`.
346
372
  #
@@ -367,8 +393,10 @@ module Google
367
393
  # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1))
368
394
  # @!attribute [rw] candidate_availability_filter
369
395
  # @return [Google::Cloud::Talent::V4beta1::CandidateAvailabilityFilter]
370
- # Optional. The candidate availability filter which filters based on
371
- # availability signals.
396
+ # Deprecated. Use availability_filters instead.
397
+ #
398
+ # The candidate availability filter which filters based on availability
399
+ # signals.
372
400
  #
373
401
  # Signal 1: Number of days since most recent job application. See
374
402
  # {Google::Cloud::Talent::V4beta1::Availability::JobApplicationAvailabilitySignal Availability::JobApplicationAvailabilitySignal}
@@ -383,9 +411,27 @@ module Google
383
411
  # based on an aggregated set of signals. Specifically, the intent is NOT to
384
412
  # indicate the candidate's potential qualification / interest / close ability
385
413
  # for a specific job.
414
+ # @!attribute [rw] availability_filters
415
+ # @return [Array<Google::Cloud::Talent::V4beta1::AvailabilityFilter>]
416
+ # The availability filter which filters based on
417
+ # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals}.
418
+ #
419
+ # The availability filter helps a recruiter understand if a
420
+ # specific candidate is likely to be actively seeking new job opportunities
421
+ # based on an aggregated set of signals. Specifically, the intent is NOT to
422
+ # indicate the candidate's potential qualification / interest / close ability
423
+ # for a specific job.
424
+ #
425
+ # There can be at most one
426
+ # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter} per
427
+ # {Google::Cloud::Talent::V4beta1::AvailabilityFilter#signal_type signal_type}.
428
+ # If there are multiple
429
+ # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter} for a
430
+ # {Google::Cloud::Talent::V4beta1::AvailabilityFilter#signal_type signal_type},
431
+ # an error is thrown.
386
432
  # @!attribute [rw] person_name_filters
387
433
  # @return [Array<Google::Cloud::Talent::V4beta1::PersonNameFilter>]
388
- # Optional. Person name filter specifies person name of profiles to match on.
434
+ # Person name filter specifies person name of profiles to match on.
389
435
  #
390
436
  # If multiple person name filters are specified, profiles that match any
391
437
  # person name filters are retrieved.
@@ -393,17 +439,15 @@ module Google
393
439
  # For example, search for profiles of candidates with name "John Smith".
394
440
  class ProfileQuery; end
395
441
 
396
- # Input only.
397
- #
398
442
  # Geographic region of the search.
399
443
  # @!attribute [rw] address
400
444
  # @return [String]
401
- # Optional. The address name, such as "Mountain View" or "Bay Area".
445
+ # The address name, such as "Mountain View" or "Bay Area".
402
446
  # @!attribute [rw] region_code
403
447
  # @return [String]
404
- # Optional. CLDR region code of the country/region of the address. This is
405
- # used to address ambiguity of the user-input location, for example,
406
- # "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK".
448
+ # CLDR region code of the country/region of the address. This is used
449
+ # to address ambiguity of the user-input location, for example, "Liverpool"
450
+ # against "Liverpool, NY, US" or "Liverpool, UK".
407
451
  #
408
452
  # Set this field to bias location resolution toward a specific country
409
453
  # or territory. If this field is not set, application behavior is biased
@@ -415,16 +459,16 @@ module Google
415
459
  # Note that this filter is not applicable for Profile Search related queries.
416
460
  # @!attribute [rw] lat_lng
417
461
  # @return [Google::Type::LatLng]
418
- # Optional. The latitude and longitude of the geographic center to search
419
- # from. This field is ignored if `address` is provided.
462
+ # The latitude and longitude of the geographic center to search from. This
463
+ # field is ignored if `address` is provided.
420
464
  # @!attribute [rw] distance_in_miles
421
465
  # @return [Float]
422
- # Optional. The distance_in_miles is applied when the location being searched
423
- # for is identified as a city or smaller. This field is ignored if the
424
- # location being searched for is a state or larger.
466
+ # The distance_in_miles is applied when the location being searched for is
467
+ # identified as a city or smaller. This field is ignored if the location
468
+ # being searched for is a state or larger.
425
469
  # @!attribute [rw] telecommute_preference
426
470
  # @return [Google::Cloud::Talent::V4beta1::LocationFilter::TelecommutePreference]
427
- # Optional. Allows the client to return jobs without a
471
+ # Allows the client to return jobs without a
428
472
  # set location, specifically, telecommuting jobs (telecommuting is considered
429
473
  # by the service as a special location.
430
474
  # {Google::Cloud::Talent::V4beta1::Job#posting_region Job#posting_region}
@@ -447,8 +491,8 @@ module Google
447
491
  # This field is only used for job search requests.
448
492
  # @!attribute [rw] negated
449
493
  # @return [true, false]
450
- # Optional. Whether to apply negation to the filter so profiles matching the
451
- # filter are excluded.
494
+ # Whether to apply negation to the filter so profiles matching the filter
495
+ # are excluded.
452
496
  #
453
497
  # Currently only supported in profile search.
454
498
  class LocationFilter
@@ -465,8 +509,6 @@ module Google
465
509
  end
466
510
  end
467
511
 
468
- # Input only.
469
- #
470
512
  # Filter on job compensation type and amount.
471
513
  # @!attribute [rw] type
472
514
  # @return [Google::Cloud::Talent::V4beta1::CompensationFilter::FilterType]
@@ -477,11 +519,11 @@ module Google
477
519
  # {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationUnit CompensationInfo::CompensationUnit}.
478
520
  # @!attribute [rw] range
479
521
  # @return [Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationRange]
480
- # Optional. Compensation range.
522
+ # Compensation range.
481
523
  # @!attribute [rw] include_jobs_with_unspecified_compensation_range
482
524
  # @return [true, false]
483
- # Optional. If set to true, jobs with unspecified compensation range fields
484
- # are included.
525
+ # If set to true, jobs with unspecified compensation range fields are
526
+ # included.
485
527
  class CompensationFilter
486
528
  # Specify the type of filtering.
487
529
  module FilterType
@@ -530,37 +572,32 @@ module Google
530
572
  end
531
573
  end
532
574
 
533
- # Input only.
534
- #
535
575
  # Parameters needed for commute search.
536
576
  # @!attribute [rw] commute_method
537
577
  # @return [Google::Cloud::Talent::V4beta1::CommuteMethod]
538
- # Required. The method of transportation for which to calculate the commute
539
- # time.
578
+ # Required. The method of transportation to calculate the commute time for.
540
579
  # @!attribute [rw] start_coordinates
541
580
  # @return [Google::Type::LatLng]
542
- # Required. The latitude and longitude of the location from which to
543
- # calculate the commute time.
581
+ # Required. The latitude and longitude of the location to calculate the
582
+ # commute time from.
544
583
  # @!attribute [rw] travel_duration
545
584
  # @return [Google::Protobuf::Duration]
546
585
  # Required. The maximum travel time in seconds. The maximum allowed value is
547
586
  # `3600s` (one hour). Format is `123s`.
548
587
  # @!attribute [rw] allow_imprecise_addresses
549
588
  # @return [true, false]
550
- # Optional. If `true`, jobs without street level addresses may also be
551
- # returned. For city level addresses, the city center is used. For state and
552
- # coarser level addresses, text matching is used. If this field is set to
553
- # `false` or isn't specified, only jobs that include street level addresses
554
- # will be returned by commute search.
589
+ # If `true`, jobs without street level addresses may also be returned.
590
+ # For city level addresses, the city center is used. For state and coarser
591
+ # level addresses, text matching is used.
592
+ # If this field is set to `false` or isn't specified, only jobs that include
593
+ # street level addresses will be returned by commute search.
555
594
  # @!attribute [rw] road_traffic
556
595
  # @return [Google::Cloud::Talent::V4beta1::CommuteFilter::RoadTraffic]
557
- # Optional. Specifies the traffic density to use when calculating commute
558
- # time.
596
+ # Specifies the traffic density to use when calculating commute time.
559
597
  # @!attribute [rw] departure_time
560
598
  # @return [Google::Type::TimeOfDay]
561
- # Optional. The departure time used to calculate traffic impact,
562
- # represented as {Google::Type::TimeOfDay} in local
563
- # time zone.
599
+ # The departure time used to calculate traffic impact, represented as
600
+ # {Google::Type::TimeOfDay} in local time zone.
564
601
  #
565
602
  # Currently traffic model is restricted to hour level resolution.
566
603
  class CommuteFilter
@@ -577,40 +614,34 @@ module Google
577
614
  end
578
615
  end
579
616
 
580
- # Input only.
581
- #
582
617
  # Job title of the search.
583
618
  # @!attribute [rw] job_title
584
619
  # @return [String]
585
- # Required. The job title, for example, "Software engineer", or "Product
620
+ # Required. The job title. For example, "Software engineer", or "Product
586
621
  # manager".
587
622
  # @!attribute [rw] negated
588
623
  # @return [true, false]
589
- # Optional. Whether to apply negation to the filter so profiles matching the
590
- # filter are excluded.
624
+ # Whether to apply negation to the filter so profiles matching the filter
625
+ # are excluded.
591
626
  class JobTitleFilter; end
592
627
 
593
- # Input only.
594
- #
595
628
  # Skill filter of the search.
596
629
  # @!attribute [rw] skill
597
630
  # @return [String]
598
631
  # Required. The skill name. For example, "java", "j2ee", and so on.
599
632
  # @!attribute [rw] negated
600
633
  # @return [true, false]
601
- # Optional. Whether to apply negation to the filter so profiles matching the
602
- # filter are excluded.
634
+ # Whether to apply negation to the filter so profiles matching the filter
635
+ # are excluded.
603
636
  class SkillFilter; end
604
637
 
605
- # Input only.
606
- #
607
638
  # Employer filter of the search.
608
639
  # @!attribute [rw] employer
609
640
  # @return [String]
610
641
  # Required. The name of the employer, for example "Google", "Alphabet".
611
642
  # @!attribute [rw] mode
612
643
  # @return [Google::Cloud::Talent::V4beta1::EmployerFilter::EmployerFilterMode]
613
- # Optional. Define set of
644
+ # Define set of
614
645
  # {Google::Cloud::Talent::V4beta1::EmploymentRecord EmploymentRecord}s to search
615
646
  # against.
616
647
  #
@@ -618,8 +649,8 @@ module Google
618
649
  # {Google::Cloud::Talent::V4beta1::EmployerFilter::EmployerFilterMode::ALL_EMPLOYMENT_RECORDS EmployerFilterMode::ALL_EMPLOYMENT_RECORDS}.
619
650
  # @!attribute [rw] negated
620
651
  # @return [true, false]
621
- # Optional. Whether to apply negation to the filter so profiles matching the
622
- # filter is excluded.
652
+ # Whether to apply negation to the filter so profiles matching the filter
653
+ # is excluded.
623
654
  class EmployerFilter
624
655
  # Enum indicating which set of
625
656
  # {Google::Cloud::Talent::V4beta1::Profile#employment_records Profile#employment_records}
@@ -642,31 +673,26 @@ module Google
642
673
  end
643
674
  end
644
675
 
645
- # Input only.
646
- #
647
676
  # Education filter of the search.
648
677
  # @!attribute [rw] school
649
678
  # @return [String]
650
- # Optional. The school name. For example "MIT", "University of California,
651
- # Berkeley".
679
+ # The school name. For example "MIT", "University of California, Berkeley".
652
680
  # @!attribute [rw] field_of_study
653
681
  # @return [String]
654
- # Optional. The field of study. This is to search against value provided in
682
+ # The field of study. This is to search against value provided in
655
683
  # {Google::Cloud::Talent::V4beta1::Degree#fields_of_study Degree#fields_of_study}.
656
684
  # For example "Computer Science", "Mathematics".
657
685
  # @!attribute [rw] degree_type
658
686
  # @return [Google::Cloud::Talent::V4beta1::DegreeType]
659
- # Optional. Education degree in ISCED code. Each value in degree covers a
660
- # specific level of education, without any expansion to upper nor lower
661
- # levels of education degree.
687
+ # Education degree in ISCED code. Each value in degree covers a specific
688
+ # level of education, without any expansion to upper nor lower levels of
689
+ # education degree.
662
690
  # @!attribute [rw] negated
663
691
  # @return [true, false]
664
- # Optional. Whether to apply negation to the filter so profiles matching the
665
- # filter is excluded.
692
+ # Whether to apply negation to the filter so profiles matching the filter
693
+ # is excluded.
666
694
  class EducationFilter; end
667
695
 
668
- # Input only.
669
- #
670
696
  # Work experience filter.
671
697
  #
672
698
  # This filter is used to search for profiles with working experience length
@@ -676,14 +702,12 @@ module Google
676
702
  # {Google::Cloud::Talent::V4beta1::WorkExperienceFilter#max_experience max_experience}.
677
703
  # @!attribute [rw] min_experience
678
704
  # @return [Google::Protobuf::Duration]
679
- # Optional. The minimum duration of the work experience (inclusive).
705
+ # The minimum duration of the work experience (inclusive).
680
706
  # @!attribute [rw] max_experience
681
707
  # @return [Google::Protobuf::Duration]
682
- # Optional. The maximum duration of the work experience (exclusive).
708
+ # The maximum duration of the work experience (exclusive).
683
709
  class WorkExperienceFilter; end
684
710
 
685
- # Input only.
686
- #
687
711
  # Application Date Range Filter.
688
712
  #
689
713
  # The API matches profiles with
@@ -695,16 +719,14 @@ module Google
695
719
  # are missing.
696
720
  # @!attribute [rw] start_date
697
721
  # @return [Google::Type::Date]
698
- # Optional. Start date. If it's missing, The API matches profiles with
699
- # application date not after the end date.
722
+ # Start date. If it's missing, The API matches profiles with application date
723
+ # not after the end date.
700
724
  # @!attribute [rw] end_date
701
725
  # @return [Google::Type::Date]
702
- # Optional. End date. If it's missing, The API matches profiles with
703
- # application date not before the start date.
726
+ # End date. If it's missing, The API matches profiles with application date
727
+ # not before the start date.
704
728
  class ApplicationDateFilter; end
705
729
 
706
- # Input only.
707
- #
708
730
  # Outcome Notes Filter.
709
731
  # @!attribute [rw] outcome_notes
710
732
  # @return [String]
@@ -714,48 +736,43 @@ module Google
714
736
  # in profiles.
715
737
  # @!attribute [rw] negated
716
738
  # @return [true, false]
717
- # Optional. If true, The API excludes all candidates with any
739
+ # If true, The API excludes all candidates with any
718
740
  # {Google::Cloud::Talent::V4beta1::Application#outcome_notes Application#outcome_notes}
719
741
  # matching the outcome reason specified in the filter.
720
742
  class ApplicationOutcomeNotesFilter; end
721
743
 
722
- # Input only.
723
- #
724
744
  # Filter on the job information of Application.
725
745
  # @!attribute [rw] job_requisition_id
726
746
  # @return [String]
727
- # Optional. The job requisition id in the application. The API does an exact
728
- # match on the
729
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id} of
747
+ # The job requisition id in the application. The API does an exact match on
748
+ # the {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id} of
730
749
  # {Google::Cloud::Talent::V4beta1::Application#job Application#job} in profiles.
731
750
  # @!attribute [rw] job_title
732
751
  # @return [String]
733
- # Optional. The job title in the application. The API does an exact match on
734
- # the {Google::Cloud::Talent::V4beta1::Job#title Job#title} of
752
+ # The job title in the application. The API does an exact match on the
753
+ # {Google::Cloud::Talent::V4beta1::Job#title Job#title} of
735
754
  # {Google::Cloud::Talent::V4beta1::Application#job Application#job} in profiles.
736
755
  # @!attribute [rw] negated
737
756
  # @return [true, false]
738
- # Optional. If true, the API excludes all profiles with any
757
+ # If true, the API excludes all profiles with any
739
758
  # {Google::Cloud::Talent::V4beta1::Application#job Application#job} matching the
740
759
  # filters.
741
760
  class ApplicationJobFilter; end
742
761
 
743
- # Input only.
744
- #
745
762
  # Filter on create timestamp or update timestamp of profiles.
746
763
  # @!attribute [rw] start_time
747
764
  # @return [Google::Protobuf::Timestamp]
748
- # Optional. Start timestamp, matching profiles with the start time. If this
749
- # field missing, The API matches profiles with create / update timestamp
750
- # before the end timestamp.
765
+ # Start timestamp, matching profiles with the start time. If this field
766
+ # missing, The API matches profiles with create / update timestamp before the
767
+ # end timestamp.
751
768
  # @!attribute [rw] end_time
752
769
  # @return [Google::Protobuf::Timestamp]
753
- # Optional. End timestamp, matching profiles with the end time. If this field
770
+ # End timestamp, matching profiles with the end time. If this field
754
771
  # missing, The API matches profiles with create / update timestamp after the
755
772
  # start timestamp.
756
773
  # @!attribute [rw] time_field
757
774
  # @return [Google::Cloud::Talent::V4beta1::TimeFilter::TimeField]
758
- # Optional. Specifies which time field to filter profiles.
775
+ # Specifies which time field to filter profiles.
759
776
  #
760
777
  # Defaults to
761
778
  # {Google::Cloud::Talent::V4beta1::TimeFilter::TimeField::CREATE_TIME TimeField::CREATE_TIME}.
@@ -773,17 +790,33 @@ module Google
773
790
  end
774
791
  end
775
792
 
776
- # Input only
793
+ # Deprecated. Use AvailabilityFilter instead.
777
794
  #
778
795
  # Filter on availability signals.
779
796
  # @!attribute [rw] negated
780
797
  # @return [true, false]
781
- # Optional. It is false by default. If true, API excludes all the potential
782
- # available profiles.
798
+ # It is false by default. If true, API excludes all the potential available
799
+ # profiles.
783
800
  class CandidateAvailabilityFilter; end
784
801
 
785
- # Input only.
786
- #
802
+ # Filter on availability signals.
803
+ # @!attribute [rw] signal_type
804
+ # @return [Google::Cloud::Talent::V4beta1::AvailabilitySignalType]
805
+ # Required. Type of signal to apply filter on.
806
+ # @!attribute [rw] range
807
+ # @return [Google::Cloud::Talent::V4beta1::TimestampRange]
808
+ # Required. Range of times to filter candidate signals by.
809
+ # @!attribute [rw] required
810
+ # @return [true, false]
811
+ # If multiple
812
+ # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter} are
813
+ # provided, the default behavior is to OR all filters, but if this field is
814
+ # set to true, this particular
815
+ # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter} will
816
+ # be AND'ed against other
817
+ # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter}.
818
+ class AvailabilityFilter; end
819
+
787
820
  # Filter on person name.
788
821
  # @!attribute [rw] person_name
789
822
  # @return [String]