Class: Google::Apis::JobsV3p1beta1::JobQuery

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3p1beta1/classes.rb,
generated/google/apis/jobs_v3p1beta1/representations.rb,
generated/google/apis/jobs_v3p1beta1/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



1788
1789
1790
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1788

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

Instance Attribute Details

#commute_filter ⇒ Google::Apis::JobsV3p1beta1::CommuteFilter

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

Returns:



1663
1664
1665
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1663

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


1675
1676
1677
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1675

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


1688
1689
1690
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1688

def company_names
  @company_names
end

#compensation_filter ⇒ Google::Apis::JobsV3p1beta1::CompensationFilter

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

Returns:



1694
1695
1696
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1694

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: (LOWER(driving_license)="class a" OR EMPTY(driving_license)) AND driving_years > 10 Corresponds to the JSON property customAttributeFilter

Returns:

  • (String) 


1715
1716
1717
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1715

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) 


1724
1725
1726
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1724

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


1736
1737
1738
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1736

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


1746
1747
1748
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1746

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


1759
1760
1761
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1759

def language_codes
  @language_codes
end

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

Returns:



1773
1774
1775
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1773

def location_filters
  @location_filters
end

#publish_time_range ⇒ Google::Apis::JobsV3p1beta1::TimestampRange

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

Returns:



1778
1779
1780
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1778

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) 


1786
1787
1788
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1786

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1793

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