Class: Google::Apis::JobsV4::JobQuery

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

Overview

The query required to perform a search query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ JobQuery

Returns a new instance of JobQuery.



1405
1406
1407
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1405

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

Instance Attribute Details

#commute_filter ⇒ Google::Apis::JobsV4::CommuteFilter

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

Returns:



1284
1285
1286
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1284

def commute_filter
  @commute_filter
end

#companies ⇒ Array<String>

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/tenants/tenant_id/companies/company_id". For example, "projects/foo/tenants/bar/companies/baz". At most 20 company filters are allowed. Corresponds to the JSON property companies

Returns:

  • (Array<String>) 


1294
1295
1296
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1294

def companies
  @companies
end

#company_display_names ⇒ Array<String>

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly. Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency. Sample Value: SUBSTRING_MATCH(google) MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency. Sample Value: MULTI_WORD_TOKEN_MATCH(google) 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>) 


1311
1312
1313
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1311

def company_display_names
  @company_display_names
end

#compensation_filter ⇒ Google::Apis::JobsV4::CompensationFilter

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

Returns:



1316
1317
1318
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1316

def compensation_filter
  @compensation_filter
end

#custom_attribute_filter ⇒ String

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 areLOWER([field_name])to perform a case insensitive match andEMPTY([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 < 10000 bytes in length. Sample Query:(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10 Corresponds to the JSON propertycustomAttributeFilter`

Returns:

  • (String) 


1332
1333
1334
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1332

def custom_attribute_filter
  @custom_attribute_filter
end

#disable_spell_check ⇒ Boolean Also known as: disable_spell_check?

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) 


1339
1340
1341
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1339

def disable_spell_check
  @disable_spell_check
end

#employment_types ⇒ Array<String>

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value isn't 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>) 


1349
1350
1351
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1349

def employment_types
  @employment_types
end

#excluded_jobs ⇒ Array<String>

This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed. Corresponds to the JSON property excludedJobs

Returns:

  • (Array<String>) 


1355
1356
1357
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1355

def excluded_jobs
  @excluded_jobs
end

#job_categories ⇒ Array<String>

The category filter specifies the categories of jobs to search against. See JobCategory for more information. If a value isn't 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>) 


1363
1364
1365
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1363

def job_categories
  @job_categories
end

#language_codes ⇒ Array<String>

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


1372
1373
1374
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1372

def language_codes
  @language_codes
end

#location_filters ⇒ Array<Google::Apis::JobsV4::LocationFilter>

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:



1383
1384
1385
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1383

def location_filters
  @location_filters
end

#publish_time_range ⇒ Google::Apis::JobsV4::TimestampRange

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

Returns:



1388
1389
1390
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1388

def publish_time_range
  @publish_time_range
end

#query ⇒ String

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) 


1394
1395
1396
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1394

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) 


1403
1404
1405
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1403

def query_language_code
  @query_language_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1410

def update!(**args)
  @commute_filter = args[:commute_filter] if args.key?(:commute_filter)
  @companies = args[:companies] if args.key?(:companies)
  @company_display_names = args[:company_display_names] if args.key?(:company_display_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)
  @excluded_jobs = args[:excluded_jobs] if args.key?(:excluded_jobs)
  @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