Class: Google::Apis::JobsV2::JobQuery
- Inherits:
-
Object
- Object
- Google::Apis::JobsV2::JobQuery
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/jobs_v2/classes.rb,
generated/google/apis/jobs_v2/representations.rb,
generated/google/apis/jobs_v2/representations.rb
Overview
Input only. The query required to perform a search query or histogram.
Instance Attribute Summary collapse
-
#categories ⇒ Array<String>
Optional.
-
#commute_filter ⇒ Google::Apis::JobsV2::CommutePreference
Input only.
-
#company_display_names ⇒ Array<String>
Optional.
-
#company_names ⇒ Array<String>
Optional.
-
#compensation_filter ⇒ Google::Apis::JobsV2::CompensationFilter
Input only.
-
#custom_attribute_filter ⇒ String
Optional.
-
#disable_spell_check ⇒ Boolean
(also: #disable_spell_check?)
Optional.
-
#employment_types ⇒ Array<String>
Optional.
-
#language_codes ⇒ Array<String>
Optional.
-
#location_filters ⇒ Array<Google::Apis::JobsV2::LocationFilter>
Optional.
-
#publish_date_range ⇒ String
Optional.
-
#query ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ JobQuery
constructor
A new instance of JobQuery.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ JobQuery
Returns a new instance of JobQuery
2367 2368 2369 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2367 def initialize(**args) update!(**args) end |
Instance Attribute Details
#categories ⇒ Array<String>
Optional.
The category filter specifies the categories of jobs to search against.
See Category for more information.
If a value is not specified, jobs from any category are searched against.
If multiple values are specified, jobs from any of the specified
categories are searched against.
Corresponds to the JSON property categories
2245 2246 2247 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2245 def categories @categories end |
#commute_filter ⇒ Google::Apis::JobsV2::CommutePreference
Input only.
Parameters needed for commute search.
Corresponds to the JSON property commuteFilter
2251 2252 2253 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2251 def commute_filter @commute_filter end |
#company_display_names ⇒ Array<String>
Optional.
This filter specifies the exact company display
name of the jobs to search against.
If a value isn't specified, jobs within the search results are
associated with any company.
If multiple values are specified, jobs within the search results may be
associated with any of the specified companies.
At most 20 company display name filters are allowed.
Corresponds to the JSON property companyDisplayNames
2263 2264 2265 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2263 def company_display_names @company_display_names end |
#company_names ⇒ Array<String>
Optional.
This filter specifies the company entities to search against.
If a value isn't specified, jobs are searched for against all
companies.
If multiple values are specified, jobs are searched against the
companies specified.
At most 20 company filters are allowed.
Corresponds to the JSON property companyNames
2274 2275 2276 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2274 def company_names @company_names end |
#compensation_filter ⇒ Google::Apis::JobsV2::CompensationFilter
Input only.
Filter on job compensation type and amount.
Corresponds to the JSON property compensationFilter
2280 2281 2282 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2280 def compensation_filter @compensation_filter end |
#custom_attribute_filter ⇒ String
Optional.
This filter specifies a structured syntax to match against the
Job.custom_attributes marked as filterable
.
The syntax for this expression is a subset of Google SQL syntax.
Supported operators are: =, !=, <, <=, >, >= where the left of the operator
is a custom field key and the right of the operator is a number or string
(surrounded by quotes) value.
Supported functions are LOWER(customAttributeFilter
2300 2301 2302 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2300 def custom_attribute_filter @custom_attribute_filter end |
#disable_spell_check ⇒ Boolean Also known as: disable_spell_check?
Optional.
This flag controls the spell-check feature. If false, the
service attempts to correct a misspelled query,
for example, "enginee" is corrected to "engineer".
Defaults to false: a spell check is performed.
Corresponds to the JSON property disableSpellCheck
2309 2310 2311 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2309 def disable_spell_check @disable_spell_check end |
#employment_types ⇒ Array<String>
Optional.
The employment type filter specifies the employment type of jobs to
search against, such as EmploymentType.FULL_TIME.
If a value is not specified, jobs in the search results include any
employment type.
If multiple values are specified, jobs in the search results include
any of the specified employment types.
Corresponds to the JSON property employmentTypes
2321 2322 2323 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2321 def employment_types @employment_types end |
#language_codes ⇒ Array<String>
Optional.
This filter specifies the locale of jobs to search against,
for example, "en-US".
If a value isn't specified, the search results can contain jobs in any
locale.
Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".
For more information, see
Tags for Identifying Languages.
At most 10 language code filters are allowed.
Corresponds to the JSON property languageCodes
2334 2335 2336 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2334 def language_codes @language_codes end |
#location_filters ⇒ Array<Google::Apis::JobsV2::LocationFilter>
Optional.
The location filter specifies geo-regions containing the jobs to
search against. See LocationFilter for more information.
If a location value isn't specified, jobs fitting the other search
criteria are retrieved regardless of where they're located.
If multiple values are specified, jobs are retrieved from any of the
specified locations, and, if different values are specified
for the LocationFilter.distance_in_miles parameter, the maximum
provided distance is used for all locations.
At most 5 location filters are allowed.
Corresponds to the JSON property locationFilters
2348 2349 2350 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2348 def location_filters @location_filters end |
#publish_date_range ⇒ String
Optional.
Jobs published within a range specified by this filter are searched
against, for example, DateRange.PAST_MONTH. If a value isn't
specified, all open jobs are searched against regardless of their
published date.
Corresponds to the JSON property publishDateRange
2357 2358 2359 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2357 def publish_date_range @publish_date_range end |
#query ⇒ String
Optional.
The query string that matches against the job title, description, and
location fields.
The maximum query size is 255 bytes.
Corresponds to the JSON property query
2365 2366 2367 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2365 def query @query end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 2372 def update!(**args) @categories = args[:categories] if args.key?(:categories) @commute_filter = args[:commute_filter] if args.key?(:commute_filter) @company_display_names = args[:company_display_names] if args.key?(:company_display_names) @company_names = args[:company_names] if args.key?(:company_names) @compensation_filter = args[:compensation_filter] if args.key?(:compensation_filter) @custom_attribute_filter = args[:custom_attribute_filter] if args.key?(:custom_attribute_filter) @disable_spell_check = args[:disable_spell_check] if args.key?(:disable_spell_check) @employment_types = args[:employment_types] if args.key?(:employment_types) @language_codes = args[:language_codes] if args.key?(:language_codes) @location_filters = args[:location_filters] if args.key?(:location_filters) @publish_date_range = args[:publish_date_range] if args.key?(:publish_date_range) @query = args[:query] if args.key?(:query) end |