Class: Google::Apis::JobsV2::JobQuery

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ JobQuery

Returns a new instance of JobQuery



2424
2425
2426
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2424

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

Returns:

  • (Array<String>) 


2302
2303
2304
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2302

def categories
  @categories
end

#commute_filter ⇒ Google::Apis::JobsV2::CommutePreference

Input only. Parameters needed for commute search. Corresponds to the JSON property commuteFilter

Returns:



2308
2309
2310
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2308

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

Returns:

  • (Array<String>) 


2320
2321
2322
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2320

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

Returns:

  • (Array<String>) 


2331
2332
2333
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2331

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

Returns:



2337
2338
2339
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2337

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() to perform case insensitive match and EMPTY() to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 Corresponds to the JSON property customAttributeFilter

Returns:

  • (String) 


2357
2358
2359
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2357

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

Returns:

  • (Boolean) 


2366
2367
2368
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2366

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

Returns:

  • (Array<String>) 


2378
2379
2380
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2378

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

Returns:

  • (Array<String>) 


2391
2392
2393
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2391

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. 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

Returns:



2405
2406
2407
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2405

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

Returns:

  • (String) 


2414
2415
2416
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2414

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

Returns:

  • (String) 


2422
2423
2424
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2422

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2429

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