google-cloud-talent-v4 0.1.0 → 0.2.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.
@@ -51,8 +51,7 @@ module Google
51
51
  # The street address of the company's main headquarters, which may be
52
52
  # different from the job location. The service attempts
53
53
  # to geolocate the provided address, and populates a more specific
54
- # location wherever possible in
55
- # {::Google::Cloud::Talent::V4::Company::DerivedInfo#headquarters_location DerivedInfo.headquarters_location}.
54
+ # location wherever possible in {::Google::Cloud::Talent::V4::Company::DerivedInfo#headquarters_location DerivedInfo.headquarters_location}.
56
55
  # @!attribute [rw] hiring_agency
57
56
  # @return [::Boolean]
58
57
  # Set to true if it is the hiring agency that post jobs for other
@@ -81,9 +80,8 @@ module Google
81
80
  # A URI that hosts the employer's company logo.
82
81
  # @!attribute [rw] keyword_searchable_job_custom_attributes
83
82
  # @return [::Array<::String>]
84
- # A list of keys of filterable
85
- # {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes},
86
- # whose corresponding `string_values` are used in keyword searches. Jobs with
83
+ # A list of keys of filterable {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}, whose
84
+ # corresponding `string_values` are used in keyword searches. Jobs with
87
85
  # `string_values` under these specified field keys are returned if any
88
86
  # of the values match the search keyword. Custom field values with
89
87
  # parenthesis, brackets and special symbols are not searchable as-is,
@@ -104,8 +102,7 @@ module Google
104
102
  # @!attribute [rw] headquarters_location
105
103
  # @return [::Google::Cloud::Talent::V4::Location]
106
104
  # A structured headquarters location of the company, resolved from
107
- # {::Google::Cloud::Talent::V4::Company#headquarters_address Company.headquarters_address}
108
- # if provided.
105
+ # {::Google::Cloud::Talent::V4::Company#headquarters_address Company.headquarters_address} if provided.
109
106
  class DerivedInfo
110
107
  include ::Google::Protobuf::MessageExts
111
108
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -52,20 +52,16 @@ module Google
52
52
  # Request for updating a specified company.
53
53
  # @!attribute [rw] company
54
54
  # @return [::Google::Cloud::Talent::V4::Company]
55
- # Required. The company resource to replace the current resource in the
56
- # system.
55
+ # Required. The company resource to replace the current resource in the system.
57
56
  # @!attribute [rw] update_mask
58
57
  # @return [::Google::Protobuf::FieldMask]
59
58
  # Strongly recommended for the best service experience.
60
59
  #
61
- # If {::Google::Cloud::Talent::V4::UpdateCompanyRequest#update_mask update_mask}
62
- # is provided, only the specified fields in
63
- # {::Google::Cloud::Talent::V4::UpdateCompanyRequest#company company} are updated.
64
- # Otherwise all the fields are updated.
60
+ # If {::Google::Cloud::Talent::V4::UpdateCompanyRequest#update_mask update_mask} is provided, only the specified fields in
61
+ # {::Google::Cloud::Talent::V4::UpdateCompanyRequest#company company} are updated. Otherwise all the fields are updated.
65
62
  #
66
63
  # A field mask to specify the company fields to be updated. Only
67
- # top level fields of {::Google::Cloud::Talent::V4::Company Company} are
68
- # supported.
64
+ # top level fields of {::Google::Cloud::Talent::V4::Company Company} are supported.
69
65
  class UpdateCompanyRequest
70
66
  include ::Google::Protobuf::MessageExts
71
67
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -104,9 +100,8 @@ module Google
104
100
  #
105
101
  # Defaults to false.
106
102
  #
107
- # If true, at most
108
- # {::Google::Cloud::Talent::V4::ListCompaniesRequest#page_size page_size} of
109
- # companies are fetched, among which only those with open jobs are returned.
103
+ # If true, at most {::Google::Cloud::Talent::V4::ListCompaniesRequest#page_size page_size} of companies are fetched, among which
104
+ # only those with open jobs are returned.
110
105
  class ListCompaniesRequest
111
106
  include ::Google::Protobuf::MessageExts
112
107
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -55,12 +55,10 @@ module Google
55
55
  # example, "projects/foo/tenants/bar/companies/baz".
56
56
  # @!attribute [rw] scope
57
57
  # @return [::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionScope]
58
- # The scope of the completion. The defaults is
59
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope.PUBLIC}.
58
+ # The scope of the completion. The defaults is {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope.PUBLIC}.
60
59
  # @!attribute [rw] type
61
60
  # @return [::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType]
62
- # The completion topic. The default is
63
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMBINED CompletionType.COMBINED}.
61
+ # The completion topic. The default is {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMBINED CompletionType.COMBINED}.
64
62
  class CompleteQueryRequest
65
63
  include ::Google::Protobuf::MessageExts
66
64
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -85,31 +83,22 @@ module Google
85
83
 
86
84
  # Suggest job titles for jobs autocomplete.
87
85
  #
88
- # For
89
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType.JOB_TITLE}
90
- # type, only open jobs with the same
91
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes}
92
- # are returned.
86
+ # For {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType.JOB_TITLE} type, only open jobs with the same
87
+ # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes} are returned.
93
88
  JOB_TITLE = 1
94
89
 
95
90
  # Suggest company names for jobs autocomplete.
96
91
  #
97
- # For
98
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType.COMPANY_NAME}
99
- # type, only companies having open jobs with the same
100
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes}
101
- # are returned.
92
+ # For {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType.COMPANY_NAME} type,
93
+ # only companies having open jobs with the same {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes} are
94
+ # returned.
102
95
  COMPANY_NAME = 2
103
96
 
104
97
  # Suggest both job titles and company names for jobs autocomplete.
105
98
  #
106
- # For
107
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMBINED CompletionType.COMBINED}
108
- # type, only open jobs with the same
109
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes}
110
- # or companies having open jobs with the same
111
- # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes}
112
- # are returned.
99
+ # For {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMBINED CompletionType.COMBINED} type, only open jobs with the same
100
+ # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes} or companies having open jobs with the same
101
+ # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes} are returned.
113
102
  COMBINED = 3
114
103
  end
115
104
  end
@@ -55,17 +55,14 @@ module Google
55
55
  # implements Cloud Talent Solution.
56
56
  # @!attribute [rw] type
57
57
  # @return [::Google::Cloud::Talent::V4::JobEvent::JobEventType]
58
- # Required. The type of the event (see
59
- # {::Google::Cloud::Talent::V4::JobEvent::JobEventType JobEventType}).
58
+ # Required. The type of the event (see {::Google::Cloud::Talent::V4::JobEvent::JobEventType JobEventType}).
60
59
  # @!attribute [rw] jobs
61
60
  # @return [::Array<::String>]
62
- # Required. The [job name(s)][google.cloud.talent.v4.Job.name] associated
63
- # with this event. For example, if this is an
64
- # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::IMPRESSION impression}
65
- # event, this field contains the identifiers of all jobs shown to the job
66
- # seeker. If this was a
67
- # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::VIEW view} event, this field
68
- # contains the identifier of the viewed job.
61
+ # Required. The [job name(s)][google.cloud.talent.v4.Job.name] associated with this event.
62
+ # For example, if this is an {::Google::Cloud::Talent::V4::JobEvent::JobEventType::IMPRESSION impression} event,
63
+ # this field contains the identifiers of all jobs shown to the job seeker.
64
+ # If this was a {::Google::Cloud::Talent::V4::JobEvent::JobEventType::VIEW view} event, this field contains the
65
+ # identifier of the viewed job.
69
66
  #
70
67
  # The format is
71
68
  # "projects/\\{project_id}/tenants/\\{tenant_id}/jobs/\\{job_id}", for
@@ -110,9 +107,7 @@ module Google
110
107
  # submitted an application for a job with a single click without
111
108
  # entering information. If a job seeker performs this action, send only
112
109
  # this event to the service. Do not also send
113
- # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_START JobEventType.APPLICATION_START}
114
- # or
115
- # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_FINISH JobEventType.APPLICATION_FINISH}
110
+ # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_START JobEventType.APPLICATION_START} or {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_FINISH JobEventType.APPLICATION_FINISH}
116
111
  # events.
117
112
  APPLICATION_QUICK_SUBMISSION = 6
118
113
 
@@ -132,11 +127,8 @@ module Google
132
127
  # (without viewing the details of the job posting), and is redirected
133
128
  # to a different website to complete the application. If a candidate
134
129
  # performs this action, send only this event to the service. Do not also
135
- # send
136
- # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_START JobEventType.APPLICATION_START},
137
- # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_FINISH JobEventType.APPLICATION_FINISH}
138
- # or {::Google::Cloud::Talent::V4::JobEvent::JobEventType::VIEW JobEventType.VIEW}
139
- # events.
130
+ # send {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_START JobEventType.APPLICATION_START},
131
+ # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_FINISH JobEventType.APPLICATION_FINISH} or {::Google::Cloud::Talent::V4::JobEvent::JobEventType::VIEW JobEventType.VIEW} events.
140
132
  APPLICATION_REDIRECT_FROM_SEARCH = 9
141
133
 
142
134
  # This event should be used when a company submits an application
@@ -30,8 +30,8 @@ module Google
30
30
  # "projects/foo/tenants/bar".
31
31
  # @!attribute [rw] client_event
32
32
  # @return [::Google::Cloud::Talent::V4::ClientEvent]
33
- # Required. Events issued when end user interacts with customer's application
34
- # that uses Cloud Talent Solution.
33
+ # Required. Events issued when end user interacts with customer's application that
34
+ # uses Cloud Talent Solution.
35
35
  class CreateClientEventRequest
36
36
  include ::Google::Protobuf::MessageExts
37
37
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -30,8 +30,8 @@ module Google
30
30
  # The maximum number of allowed characters is 255.
31
31
  # @!attribute [rw] query_language_code
32
32
  # @return [::String]
33
- # The language code of {::Google::Cloud::Talent::V4::JobQuery#query query}. For
34
- # example, "en-US". This field helps to better interpret the query.
33
+ # The language code of {::Google::Cloud::Talent::V4::JobQuery#query query}. For example, "en-US". This field helps to
34
+ # better interpret the query.
35
35
  #
36
36
  # If a value isn't specified, the query language code is automatically
37
37
  # detected, which may not be accurate.
@@ -57,16 +57,15 @@ module Google
57
57
  # @!attribute [rw] location_filters
58
58
  # @return [::Array<::Google::Cloud::Talent::V4::LocationFilter>]
59
59
  # The location filter specifies geo-regions containing the jobs to
60
- # search against. See {::Google::Cloud::Talent::V4::LocationFilter LocationFilter}
61
- # for more information.
60
+ # search against. See {::Google::Cloud::Talent::V4::LocationFilter LocationFilter} for more information.
62
61
  #
63
62
  # If a location value isn't specified, jobs fitting the other search
64
63
  # criteria are retrieved regardless of where they're located.
65
64
  #
66
65
  # If multiple values are specified, jobs are retrieved from any of the
67
66
  # specified locations. If different values are specified for the
68
- # {::Google::Cloud::Talent::V4::LocationFilter#distance_in_miles LocationFilter.distance_in_miles}
69
- # parameter, the maximum provided distance is used for all locations.
67
+ # {::Google::Cloud::Talent::V4::LocationFilter#distance_in_miles LocationFilter.distance_in_miles} parameter, the maximum provided
68
+ # distance is used for all locations.
70
69
  #
71
70
  # At most 5 location filters are allowed.
72
71
  # @!attribute [rw] job_categories
@@ -83,17 +82,14 @@ module Google
83
82
  # Allows filtering jobs by commute time with different travel methods (for
84
83
  # example, driving or public transit).
85
84
  #
86
- # Note: This only works when you specify a
87
- # {::Google::Cloud::Talent::V4::CommuteMethod CommuteMethod}. In this case,
88
- # {::Google::Cloud::Talent::V4::JobQuery#location_filters location_filters} is
89
- # ignored.
85
+ # Note: This only works when you specify a {::Google::Cloud::Talent::V4::CommuteMethod CommuteMethod}. In this case,
86
+ # {::Google::Cloud::Talent::V4::JobQuery#location_filters location_filters} is ignored.
90
87
  #
91
88
  # Currently we don't support sorting by commute time.
92
89
  # @!attribute [rw] company_display_names
93
90
  # @return [::Array<::String>]
94
- # This filter specifies the exact company
95
- # {::Google::Cloud::Talent::V4::Company#display_name Company.display_name} of the
96
- # jobs to search against.
91
+ # This filter specifies the exact company {::Google::Cloud::Talent::V4::Company#display_name Company.display_name}
92
+ # of the jobs to search against.
97
93
  #
98
94
  # If a value isn't specified, jobs within the search results are
99
95
  # associated with any company.
@@ -105,15 +101,14 @@ module Google
105
101
  # @!attribute [rw] compensation_filter
106
102
  # @return [::Google::Cloud::Talent::V4::CompensationFilter]
107
103
  # This search filter is applied only to
108
- # {::Google::Cloud::Talent::V4::Job#compensation_info Job.compensation_info}. For
109
- # example, if the filter is specified as "Hourly job with per-hour
110
- # compensation > $15", only jobs meeting these criteria are searched. If a
111
- # filter isn't defined, all open jobs are searched.
104
+ # {::Google::Cloud::Talent::V4::Job#compensation_info Job.compensation_info}. For example, if the filter is specified
105
+ # as "Hourly job with per-hour compensation > $15", only jobs meeting
106
+ # these criteria are searched. If a filter isn't defined, all open jobs
107
+ # are searched.
112
108
  # @!attribute [rw] custom_attribute_filter
113
109
  # @return [::String]
114
110
  # This filter specifies a structured syntax to match against the
115
- # {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}
116
- # marked as `filterable`.
111
+ # {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes} marked as `filterable`.
117
112
  #
118
113
  # The syntax for this expression is a subset of SQL syntax.
119
114
  #
@@ -144,8 +139,7 @@ module Google
144
139
  # @!attribute [rw] employment_types
145
140
  # @return [::Array<::Google::Cloud::Talent::V4::EmploymentType>]
146
141
  # The employment type filter specifies the employment type of jobs to
147
- # search against, such as
148
- # {::Google::Cloud::Talent::V4::EmploymentType::FULL_TIME EmploymentType.FULL_TIME}.
142
+ # search against, such as {::Google::Cloud::Talent::V4::EmploymentType::FULL_TIME EmploymentType.FULL_TIME}.
149
143
  #
150
144
  # If a value isn't specified, jobs in the search results includes any
151
145
  # employment type.
@@ -211,15 +205,12 @@ module Google
211
205
  # Allows the client to return jobs without a
212
206
  # set location, specifically, telecommuting jobs (telecommuting is considered
213
207
  # by the service as a special location.
214
- # {::Google::Cloud::Talent::V4::Job#posting_region Job.posting_region} indicates
215
- # if a job permits telecommuting. If this field is set to
216
- # {::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference::TELECOMMUTE_ALLOWED TelecommutePreference.TELECOMMUTE_ALLOWED},
217
- # telecommuting jobs are searched, and
218
- # {::Google::Cloud::Talent::V4::LocationFilter#address address} and
219
- # {::Google::Cloud::Talent::V4::LocationFilter#lat_lng lat_lng} are ignored. If
220
- # not set or set to
221
- # {::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference::TELECOMMUTE_EXCLUDED TelecommutePreference.TELECOMMUTE_EXCLUDED},
222
- # telecommute job are not searched.
208
+ # {::Google::Cloud::Talent::V4::Job#posting_region Job.posting_region} indicates if a job permits telecommuting.
209
+ # If this field is set to {::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference::TELECOMMUTE_ALLOWED TelecommutePreference.TELECOMMUTE_ALLOWED},
210
+ # telecommuting jobs are searched, and {::Google::Cloud::Talent::V4::LocationFilter#address address} and {::Google::Cloud::Talent::V4::LocationFilter#lat_lng lat_lng} are
211
+ # ignored. If not set or set to
212
+ # {::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference::TELECOMMUTE_EXCLUDED TelecommutePreference.TELECOMMUTE_EXCLUDED}, telecommute job are not
213
+ # searched.
223
214
  #
224
215
  # This filter can be used by itself to search exclusively for telecommuting
225
216
  # jobs, or it can be combined with another location
@@ -272,40 +263,32 @@ module Google
272
263
 
273
264
  # Filter by `base compensation entry's` unit. A job is a match if and
274
265
  # only if the job contains a base CompensationEntry and the base
275
- # CompensationEntry's unit matches provided
276
- # {::Google::Cloud::Talent::V4::CompensationFilter#units units}. Populate one or
277
- # more {::Google::Cloud::Talent::V4::CompensationFilter#units units}.
266
+ # CompensationEntry's unit matches provided {::Google::Cloud::Talent::V4::CompensationFilter#units units}.
267
+ # Populate one or more {::Google::Cloud::Talent::V4::CompensationFilter#units units}.
278
268
  #
279
- # See
280
- # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry CompensationInfo.CompensationEntry}
281
- # for definition of base compensation entry.
269
+ # See {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry CompensationInfo.CompensationEntry} for definition of
270
+ # base compensation entry.
282
271
  UNIT_ONLY = 1
283
272
 
284
273
  # Filter by `base compensation entry's` unit and amount / range. A job
285
274
  # is a match if and only if the job contains a base CompensationEntry, and
286
275
  # the base entry's unit matches provided
287
- # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit CompensationUnit}
288
- # and amount or range overlaps with provided
276
+ # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit CompensationUnit} and
277
+ # amount or range overlaps with provided
289
278
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationRange CompensationRange}.
290
279
  #
291
- # See
292
- # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry CompensationInfo.CompensationEntry}
293
- # for definition of base compensation entry.
280
+ # See {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry CompensationInfo.CompensationEntry} for definition of
281
+ # base compensation entry.
294
282
  #
295
- # Set exactly one {::Google::Cloud::Talent::V4::CompensationFilter#units units}
296
- # and populate {::Google::Cloud::Talent::V4::CompensationFilter#range range}.
283
+ # Set exactly one {::Google::Cloud::Talent::V4::CompensationFilter#units units} and populate {::Google::Cloud::Talent::V4::CompensationFilter#range range}.
297
284
  UNIT_AND_AMOUNT = 2
298
285
 
299
286
  # Filter by annualized base compensation amount and `base compensation
300
- # entry's` unit. Populate
301
- # {::Google::Cloud::Talent::V4::CompensationFilter#range range} and zero or more
302
- # {::Google::Cloud::Talent::V4::CompensationFilter#units units}.
287
+ # entry's` unit. Populate [range][google.cloud.talent.v4.CompensationFilter.range] and zero or more [units][google.cloud.talent.v4.CompensationFilter.units].
303
288
  ANNUALIZED_BASE_AMOUNT = 3
304
289
 
305
290
  # Filter by annualized total compensation amount and `base compensation
306
- # entry's` unit . Populate
307
- # {::Google::Cloud::Talent::V4::CompensationFilter#range range} and zero or more
308
- # {::Google::Cloud::Talent::V4::CompensationFilter#units units}.
291
+ # entry's` unit . Populate [range][google.cloud.talent.v4.CompensationFilter.range] and zero or more [units][google.cloud.talent.v4.CompensationFilter.units].
309
292
  ANNUALIZED_TOTAL_AMOUNT = 4
310
293
  end
311
294
  end
@@ -320,8 +303,8 @@ module Google
320
303
  # commute time from.
321
304
  # @!attribute [rw] travel_duration
322
305
  # @return [::Google::Protobuf::Duration]
323
- # Required. The maximum travel time in seconds. The maximum allowed value is
324
- # `3600s` (one hour). Format is `123s`.
306
+ # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
307
+ # (one hour). Format is `123s`.
325
308
  # @!attribute [rw] allow_imprecise_addresses
326
309
  # @return [::Boolean]
327
310
  # If `true`, jobs without street level addresses may also be returned.
@@ -27,17 +27,13 @@ module Google
27
27
  # An expression specifies a histogram request against matching jobs for
28
28
  # searches.
29
29
  #
30
- # See
31
- # {::Google::Cloud::Talent::V4::SearchJobsRequest#histogram_queries SearchJobsRequest.histogram_queries}
32
- # for details about syntax.
30
+ # See {::Google::Cloud::Talent::V4::SearchJobsRequest#histogram_queries SearchJobsRequest.histogram_queries} for details about syntax.
33
31
  class HistogramQuery
34
32
  include ::Google::Protobuf::MessageExts
35
33
  extend ::Google::Protobuf::MessageExts::ClassMethods
36
34
  end
37
35
 
38
- # Histogram result that matches
39
- # {::Google::Cloud::Talent::V4::HistogramQuery HistogramQuery} specified in
40
- # searches.
36
+ # Histogram result that matches {::Google::Cloud::Talent::V4::HistogramQuery HistogramQuery} specified in searches.
41
37
  # @!attribute [rw] histogram_query
42
38
  # @return [::String]
43
39
  # Requested histogram expression.
@@ -22,9 +22,8 @@ module Google
22
22
  module Talent
23
23
  module V4
24
24
  # A Job resource represents a job posting (also referred to as a "job listing"
25
- # or "job requisition"). A job belongs to a
26
- # {::Google::Cloud::Talent::V4::Company Company}, which is the hiring entity
27
- # responsible for the job.
25
+ # or "job requisition"). A job belongs to a {::Google::Cloud::Talent::V4::Company Company}, which is the hiring
26
+ # entity responsible for the job.
28
27
  # @!attribute [rw] name
29
28
  # @return [::String]
30
29
  # Required during job update.
@@ -37,8 +36,7 @@ module Google
37
36
  # example, "projects/foo/tenants/bar/jobs/baz".
38
37
  #
39
38
  # Use of this field in job queries and API calls is preferred over the use of
40
- # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id} since this
41
- # value is unique.
39
+ # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id} since this value is unique.
42
40
  # @!attribute [rw] company
43
41
  # @return [::String]
44
42
  # Required. The resource name of the company listing the job.
@@ -48,13 +46,11 @@ module Google
48
46
  # example, "projects/foo/tenants/bar/companies/baz".
49
47
  # @!attribute [rw] requisition_id
50
48
  # @return [::String]
51
- # Required. The requisition ID, also referred to as the posting ID, is
52
- # assigned by the client to identify a job. This field is intended to be used
53
- # by clients for client identification and tracking of postings. A job isn't
54
- # allowed to be created if there is another job with the same
55
- # {::Google::Cloud::Talent::V4::Job#name company},
56
- # {::Google::Cloud::Talent::V4::Job#language_code language_code} and
57
- # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id}.
49
+ # Required. The requisition ID, also referred to as the posting ID, is assigned by the
50
+ # client to identify a job. This field is intended to be used by clients
51
+ # for client identification and tracking of postings. A job isn't allowed
52
+ # to be created if there is another job with the same {::Google::Cloud::Talent::V4::Job#name company},
53
+ # {::Google::Cloud::Talent::V4::Job#language_code language_code} and {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id}.
58
54
  #
59
55
  # The maximum number of allowed characters is 255.
60
56
  # @!attribute [rw] title
@@ -64,12 +60,11 @@ module Google
64
60
  # The maximum number of allowed characters is 500.
65
61
  # @!attribute [rw] description
66
62
  # @return [::String]
67
- # Required. The description of the job, which typically includes a
68
- # multi-paragraph description of the company and related information.
69
- # Separate fields are provided on the job object for
70
- # {::Google::Cloud::Talent::V4::Job#responsibilities responsibilities},
71
- # {::Google::Cloud::Talent::V4::Job#qualifications qualifications}, and other job
72
- # characteristics. Use of these separate job fields is recommended.
63
+ # Required. The description of the job, which typically includes a multi-paragraph
64
+ # description of the company and related information. Separate fields are
65
+ # provided on the job object for {::Google::Cloud::Talent::V4::Job#responsibilities responsibilities},
66
+ # {::Google::Cloud::Talent::V4::Job#qualifications qualifications}, and other job characteristics. Use of
67
+ # these separate job fields is recommended.
73
68
  #
74
69
  # This field accepts and sanitizes HTML input, and also accepts
75
70
  # bold, italic, ordered list, and unordered list markup tags.
@@ -86,16 +81,12 @@ module Google
86
81
  #
87
82
  # At most 50 locations are allowed for best search performance. If a job has
88
83
  # more locations, it is suggested to split it into multiple jobs with unique
89
- # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id}s (e.g. 'ReqA'
90
- # becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same
91
- # {::Google::Cloud::Talent::V4::Job#company company},
92
- # {::Google::Cloud::Talent::V4::Job#language_code language_code} and
93
- # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id} are not
94
- # allowed. If the original
95
- # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id} must be
96
- # preserved, a custom field should be used for storage. It is also suggested
97
- # to group the locations that close to each other in the same job for better
98
- # search experience.
84
+ # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id}s (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as
85
+ # multiple jobs with the same {::Google::Cloud::Talent::V4::Job#company company}, {::Google::Cloud::Talent::V4::Job#language_code language_code} and
86
+ # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id} are not allowed. If the original {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id} must
87
+ # be preserved, a custom field should be used for storage. It is also
88
+ # suggested to group the locations that close to each other in the same job
89
+ # for better search experience.
99
90
  #
100
91
  # The maximum number of allowed characters is 500.
101
92
  # @!attribute [rw] application_info
@@ -152,11 +143,9 @@ module Google
152
143
  # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
153
144
  # class="external" target="_blank" }.
154
145
  #
155
- # If this field is unspecified and
156
- # {::Google::Cloud::Talent::V4::Job#description Job.description} is present,
157
- # detected language code based on
158
- # {::Google::Cloud::Talent::V4::Job#description Job.description} is assigned,
159
- # otherwise defaults to 'en_US'.
146
+ # If this field is unspecified and {::Google::Cloud::Talent::V4::Job#description Job.description} is present, detected
147
+ # language code based on {::Google::Cloud::Talent::V4::Job#description Job.description} is assigned, otherwise
148
+ # defaults to 'en_US'.
160
149
  # @!attribute [rw] job_level
161
150
  # @return [::Google::Cloud::Talent::V4::JobLevel]
162
151
  # The experience level associated with the job, such as "Entry Level".
@@ -173,8 +162,7 @@ module Google
173
162
  # @return [::String]
174
163
  # A description of the qualifications required to perform the
175
164
  # job. The use of this field is recommended
176
- # as an alternative to using the more general
177
- # {::Google::Cloud::Talent::V4::Job#description description} field.
165
+ # as an alternative to using the more general {::Google::Cloud::Talent::V4::Job#description description} field.
178
166
  #
179
167
  # This field accepts and sanitizes HTML input, and also accepts
180
168
  # bold, italic, ordered list, and unordered list markup tags.
@@ -183,8 +171,8 @@ module Google
183
171
  # @!attribute [rw] responsibilities
184
172
  # @return [::String]
185
173
  # A description of job responsibilities. The use of this field is
186
- # recommended as an alternative to using the more general
187
- # {::Google::Cloud::Talent::V4::Job#description description} field.
174
+ # recommended as an alternative to using the more general {::Google::Cloud::Talent::V4::Job#description description}
175
+ # field.
188
176
  #
189
177
  # This field accepts and sanitizes HTML input, and also accepts
190
178
  # bold, italic, ordered list, and unordered list markup tags.
@@ -192,24 +180,20 @@ module Google
192
180
  # The maximum number of allowed characters is 10,000.
193
181
  # @!attribute [rw] posting_region
194
182
  # @return [::Google::Cloud::Talent::V4::PostingRegion]
195
- # The job {::Google::Cloud::Talent::V4::PostingRegion PostingRegion} (for example,
196
- # state, country) throughout which the job is available. If this field is
197
- # set, a {::Google::Cloud::Talent::V4::LocationFilter LocationFilter} in a search
198
- # query within the job region finds this job posting if an exact location
199
- # match isn't specified. If this field is set to
200
- # {::Google::Cloud::Talent::V4::PostingRegion::NATION PostingRegion.NATION} or
201
- # {::Google::Cloud::Talent::V4::PostingRegion::ADMINISTRATIVE_AREA PostingRegion.ADMINISTRATIVE_AREA},
202
- # setting job {::Google::Cloud::Talent::V4::Job#addresses Job.addresses} to the
203
- # same location level as this field is strongly recommended.
183
+ # The job {::Google::Cloud::Talent::V4::PostingRegion PostingRegion} (for example, state, country) throughout
184
+ # which the job is available. If this field is set, a {::Google::Cloud::Talent::V4::LocationFilter LocationFilter}
185
+ # in a search query within the job region finds this job posting if an
186
+ # exact location match isn't specified. If this field is set to
187
+ # {::Google::Cloud::Talent::V4::PostingRegion::NATION PostingRegion.NATION} or {::Google::Cloud::Talent::V4::PostingRegion::ADMINISTRATIVE_AREA PostingRegion.ADMINISTRATIVE_AREA},
188
+ # setting job {::Google::Cloud::Talent::V4::Job#addresses Job.addresses} to the same location level as this field
189
+ # is strongly recommended.
204
190
  # @!attribute [rw] visibility
205
191
  # @return [::Google::Cloud::Talent::V4::Visibility]
206
192
  # Deprecated. The job is only visible to the owner.
207
193
  #
208
194
  # The visibility of the job.
209
195
  #
210
- # Defaults to
211
- # {::Google::Cloud::Talent::V4::Visibility::ACCOUNT_ONLY Visibility.ACCOUNT_ONLY}
212
- # if not specified.
196
+ # Defaults to {::Google::Cloud::Talent::V4::Visibility::ACCOUNT_ONLY Visibility.ACCOUNT_ONLY} if not specified.
213
197
  # @!attribute [rw] job_start_time
214
198
  # @return [::Google::Protobuf::Timestamp]
215
199
  # The start timestamp of the job in UTC time zone. Typically this field
@@ -229,17 +213,13 @@ module Google
229
213
  #
230
214
  # The expiration timestamp of the job. After this timestamp, the
231
215
  # job is marked as expired, and it no longer appears in search results. The
232
- # expired job can't be listed by the
233
- # {::Google::Cloud::Talent::V4::JobService::Client#list_jobs ListJobs} API, but it can be
234
- # retrieved with the {::Google::Cloud::Talent::V4::JobService::Client#get_job GetJob} API
235
- # or updated with the
236
- # {::Google::Cloud::Talent::V4::JobService::Client#update_job UpdateJob} API or deleted
237
- # with the {::Google::Cloud::Talent::V4::JobService::Client#delete_job DeleteJob} API. An
238
- # expired job can be updated and opened again by using a future expiration
239
- # timestamp. Updating an expired job fails if there is another existing open
240
- # job with same {::Google::Cloud::Talent::V4::Job#company company},
241
- # {::Google::Cloud::Talent::V4::Job#language_code language_code} and
242
- # {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id}.
216
+ # expired job can't be listed by the {::Google::Cloud::Talent::V4::JobService::Client#list_jobs ListJobs} API,
217
+ # but it can be retrieved with the {::Google::Cloud::Talent::V4::JobService::Client#get_job GetJob} API or
218
+ # updated with the {::Google::Cloud::Talent::V4::JobService::Client#update_job UpdateJob} API or deleted with
219
+ # the {::Google::Cloud::Talent::V4::JobService::Client#delete_job DeleteJob} API. An expired job can
220
+ # be updated and opened again by using a future expiration timestamp.
221
+ # Updating an expired job fails if there is another existing open job with
222
+ # same {::Google::Cloud::Talent::V4::Job#company company}, {::Google::Cloud::Talent::V4::Job#language_code language_code} and {::Google::Cloud::Talent::V4::Job#requisition_id requisition_id}.
243
223
  #
244
224
  # The expired jobs are retained in our system for 90 days. However, the
245
225
  # overall expired job count cannot exceed 3 times the maximum number of
@@ -253,13 +233,12 @@ module Google
253
233
  # If the timestamp is before the instant request is made, the job
254
234
  # is treated as expired immediately on creation. This kind of job can
255
235
  # not be updated. And when creating a job with past timestamp, the
256
- # {::Google::Cloud::Talent::V4::Job#posting_publish_time posting_publish_time}
257
- # must be set before
258
- # {::Google::Cloud::Talent::V4::Job#posting_expire_time posting_expire_time}. The
259
- # purpose of this feature is to allow other objects, such as [Application][],
260
- # to refer a job that didn't exist in the system prior to becoming expired.
261
- # If you want to modify a job that was expired on creation, delete it and
262
- # create a new one.
236
+ # {::Google::Cloud::Talent::V4::Job#posting_publish_time posting_publish_time} must be set before
237
+ # {::Google::Cloud::Talent::V4::Job#posting_expire_time posting_expire_time}. The purpose of this feature is
238
+ # to allow other objects, such as [Application][], to refer a job
239
+ # that didn't exist in the system prior to becoming expired. If you
240
+ # want to modify a job that was expired on creation,
241
+ # delete it and create a new one.
263
242
  #
264
243
  # If this value isn't provided at the time of job creation or is invalid,
265
244
  # the job posting expires after 30 days from the job's creation time. For
@@ -267,13 +246,10 @@ module Google
267
246
  # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
268
247
  #
269
248
  # If this value isn't provided on job update, it depends on the field masks
270
- # set by
271
- # {::Google::Cloud::Talent::V4::UpdateJobRequest#update_mask UpdateJobRequest.update_mask}.
272
- # If the field masks include
273
- # {::Google::Cloud::Talent::V4::Job#job_end_time job_end_time}, or the masks are
274
- # empty meaning that every field is updated, the job posting expires after 30
275
- # days from the job's last update time. Otherwise the expiration date isn't
276
- # updated.
249
+ # set by {::Google::Cloud::Talent::V4::UpdateJobRequest#update_mask UpdateJobRequest.update_mask}. If the field masks include
250
+ # {::Google::Cloud::Talent::V4::Job#job_end_time job_end_time}, or the masks are empty meaning that every field is
251
+ # updated, the job posting expires after 30 days from the job's last
252
+ # update time. Otherwise the expiration date isn't updated.
277
253
  # @!attribute [r] posting_create_time
278
254
  # @return [::Google::Protobuf::Timestamp]
279
255
  # Output only. The timestamp when this job posting was created.
@@ -323,16 +299,13 @@ module Google
323
299
  # Derived details about the job posting.
324
300
  # @!attribute [rw] locations
325
301
  # @return [::Array<::Google::Cloud::Talent::V4::Location>]
326
- # Structured locations of the job, resolved from
327
- # {::Google::Cloud::Talent::V4::Job#addresses Job.addresses}.
302
+ # Structured locations of the job, resolved from {::Google::Cloud::Talent::V4::Job#addresses Job.addresses}.
328
303
  #
329
- # {::Google::Cloud::Talent::V4::Job::DerivedInfo#locations locations} are exactly
330
- # matched to {::Google::Cloud::Talent::V4::Job#addresses Job.addresses} in the
331
- # same order.
304
+ # {::Google::Cloud::Talent::V4::Job::DerivedInfo#locations locations} are exactly matched to {::Google::Cloud::Talent::V4::Job#addresses Job.addresses} in the same
305
+ # order.
332
306
  # @!attribute [rw] job_categories
333
307
  # @return [::Array<::Google::Cloud::Talent::V4::JobCategory>]
334
- # Job categories derived from {::Google::Cloud::Talent::V4::Job#title Job.title}
335
- # and {::Google::Cloud::Talent::V4::Job#description Job.description}.
308
+ # Job categories derived from {::Google::Cloud::Talent::V4::Job#title Job.title} and {::Google::Cloud::Talent::V4::Job#description Job.description}.
336
309
  class DerivedInfo
337
310
  include ::Google::Protobuf::MessageExts
338
311
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -356,8 +329,7 @@ module Google
356
329
  # HTML tags in these fields may be stripped if sanitiazation isn't
357
330
  # disabled.
358
331
  #
359
- # Defaults to
360
- # {::Google::Cloud::Talent::V4::HtmlSanitization::SIMPLE_FORMATTING_ONLY HtmlSanitization.SIMPLE_FORMATTING_ONLY}.
332
+ # Defaults to {::Google::Cloud::Talent::V4::HtmlSanitization::SIMPLE_FORMATTING_ONLY HtmlSanitization.SIMPLE_FORMATTING_ONLY}.
361
333
  class ProcessingOptions
362
334
  include ::Google::Protobuf::MessageExts
363
335
  extend ::Google::Protobuf::MessageExts::ClassMethods