Class: Google::Apis::JobsV2::JobFilters

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. Deprecated. Use JobQuery instead. The filters 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) ⇒ JobFilters

Returns a new instance of JobFilters.



2094
2095
2096
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2094

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


1952
1953
1954
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1952

def categories
  @categories
end

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

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

Returns:



1958
1959
1960
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1958

def commute_filter
  @commute_filter
end

#company_names ⇒ Array<String>

Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed. Corresponds to the JSON property companyNames

Returns:

  • (Array<String>) 


1968
1969
1970
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1968

def company_names
  @company_names
end

#company_titles ⇒ Array<String>

Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be 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 title filters are allowed. Corresponds to the JSON property companyTitles

Returns:

  • (Array<String>) 


1979
1980
1981
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1979

def company_titles
  @company_titles
end

#compensation_filter ⇒ Google::Apis::JobsV2::CompensationFilter

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

Returns:



1985
1986
1987
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1985

def compensation_filter
  @compensation_filter
end

#custom_attribute_filter ⇒ String

Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are 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"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes 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) 


2004
2005
2006
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2004

def custom_attribute_filter
  @custom_attribute_filter
end

#custom_field_filters ⇒ Hash<String,Google::Apis::JobsV2::CustomFieldFilter>

Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding to the desired custom field map value. If an invalid key is provided or specified together with custom_attribute_filter, an error is thrown. Corresponds to the JSON property customFieldFilters

Returns:



2016
2017
2018
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2016

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


2024
2025
2026
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2024

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


2035
2036
2037
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2035

def employment_types
  @employment_types
end

#extended_compensation_filter ⇒ Google::Apis::JobsV2::ExtendedCompensationFilter

Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount. Corresponds to the JSON property extendedCompensationFilter

Returns:



2042
2043
2044
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2042

def extended_compensation_filter
  @extended_compensation_filter
end

#language_codes ⇒ Array<String>

Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, "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>) 


2054
2055
2056
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2054

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 is not specified, jobs are retrieved from all locations. 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:



2067
2068
2069
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2067

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 is not specified, all open jobs are searched against regardless of the date they were published. Corresponds to the JSON property publishDateRange

Returns:

  • (String) 


2075
2076
2077
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2075

def publish_date_range
  @publish_date_range
end

#query ⇒ String

Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters. Corresponds to the JSON property query

Returns:

  • (String) 


2082
2083
2084
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2082

def query
  @query
end

#tenant_job_only ⇒ Boolean Also known as: tenant_job_only?

Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against. Corresponds to the JSON property tenantJobOnly

Returns:

  • (Boolean) 


2091
2092
2093
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2091

def tenant_job_only
  @tenant_job_only
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2099

def update!(**args)
  @categories = args[:categories] if args.key?(:categories)
  @commute_filter = args[:commute_filter] if args.key?(:commute_filter)
  @company_names = args[:company_names] if args.key?(:company_names)
  @company_titles = args[:company_titles] if args.key?(:company_titles)
  @compensation_filter = args[:compensation_filter] if args.key?(:compensation_filter)
  @custom_attribute_filter = args[:custom_attribute_filter] if args.key?(:custom_attribute_filter)
  @custom_field_filters = args[:custom_field_filters] if args.key?(:custom_field_filters)
  @disable_spell_check = args[:disable_spell_check] if args.key?(:disable_spell_check)
  @employment_types = args[:employment_types] if args.key?(:employment_types)
  @extended_compensation_filter = args[:extended_compensation_filter] if args.key?(:extended_compensation_filter)
  @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)
  @tenant_job_only = args[:tenant_job_only] if args.key?(:tenant_job_only)
end