Class: Google::Apis::JobsV3::JobQuery

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3/classes.rb,
generated/google/apis/jobs_v3/representations.rb,
generated/google/apis/jobs_v3/representations.rb

Overview

Input only. The query required to perform a search query.

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.



1587
1588
1589
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1587

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#commute_filter ⇒ Google::Apis::JobsV3::CommuteFilter

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

Returns:



1457
1458
1459
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1457

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


1468
1469
1470
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1468

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. The format is "projects/project_id/companies/company_id", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. Corresponds to the JSON property companyNames

Returns:

  • (Array<String>) 


1480
1481
1482
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1480

def company_names
  @company_names
end

#compensation_filter ⇒ Google::Apis::JobsV3::CompensationFilter

Input only. Filter on job compensation type and amount. Corresponds to the JSON property compensationFilter

Returns:



1486
1487
1488
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1486

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 SQL syntax. Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\) and quote (\") characters. Supported functions are LOWER([field_name]) to perform a case insensitive match and EMPTY([field_name]) 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 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: (LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10 Corresponds to the JSON property customAttributeFilter

Returns:

  • (String) 


1507
1508
1509
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1507

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) 


1515
1516
1517
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1515

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 includes 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>) 


1526
1527
1528
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1526

def employment_types
  @employment_types
end

#job_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 jobCategories

Returns:

  • (Array<String>) 


1536
1537
1538
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1536

def job_categories
  @job_categories
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>) 


1548
1549
1550
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1548

def language_codes
  @language_codes
end

#location_filters ⇒ Array<Google::Apis::JobsV3::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:



1561
1562
1563
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1561

def location_filters
  @location_filters
end

#publish_time_range ⇒ Google::Apis::JobsV3::TimestampRange

Message representing a period of time between two timestamps. Corresponds to the JSON property publishTimeRange

Returns:



1566
1567
1568
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1566

def publish_time_range
  @publish_time_range
end

#query ⇒ String

Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. Corresponds to the JSON property query

Returns:

  • (String) 


1574
1575
1576
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1574

def query
  @query
end

#query_language_code ⇒ String

The language code of query. For example, "en-US". This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. Corresponds to the JSON property queryLanguageCode

Returns:

  • (String) 


1585
1586
1587
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1585

def query_language_code
  @query_language_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1592

def update!(**args)
  @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)
  @job_categories = args[:job_categories] if args.key?(:job_categories)
  @language_codes = args[:language_codes] if args.key?(:language_codes)
  @location_filters = args[:location_filters] if args.key?(:location_filters)
  @publish_time_range = args[:publish_time_range] if args.key?(:publish_time_range)
  @query = args[:query] if args.key?(:query)
  @query_language_code = args[:query_language_code] if args.key?(:query_language_code)
end