Class: Google::Apis::JobsV3p1beta1::JobQuery
- Inherits:
-
Object
- Object
- Google::Apis::JobsV3p1beta1::JobQuery
- 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
-
#commute_filter ⇒ Google::Apis::JobsV3p1beta1::CommuteFilter
Input only.
-
#company_display_names ⇒ Array<String>
Optional.
-
#company_names ⇒ Array<String>
Optional.
-
#compensation_filter ⇒ Google::Apis::JobsV3p1beta1::CompensationFilter
Input only.
-
#custom_attribute_filter ⇒ String
Optional.
-
#disable_spell_check ⇒ Boolean
(also: #disable_spell_check?)
Optional.
-
#employment_types ⇒ Array<String>
Optional.
-
#excluded_jobs ⇒ Array<String>
Optional.
-
#job_categories ⇒ Array<String>
Optional.
-
#language_codes ⇒ Array<String>
Optional.
-
#location_filters ⇒ Array<Google::Apis::JobsV3p1beta1::LocationFilter>
Optional.
-
#publish_time_range ⇒ Google::Apis::JobsV3p1beta1::TimestampRange
Message representing a period of time between two timestamps.
-
#query ⇒ String
Optional.
-
#query_language_code ⇒ String
The language code of query.
Instance Method Summary collapse
-
#initialize(**args) ⇒ JobQuery
constructor
A new instance of JobQuery.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ JobQuery
Returns a new instance of JobQuery.
1769 1770 1771 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1769 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
1632 1633 1634 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1632 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
1643 1644 1645 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1643 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
1655 1656 1657 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1655 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
1661 1662 1663 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1661 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
1682 1683 1684 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1682 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
1690 1691 1692 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1690 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
1701 1702 1703 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1701 def employment_types @employment_types end |
#excluded_jobs ⇒ Array<String>
Optional. 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
1708 1709 1710 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1708 def excluded_jobs @excluded_jobs 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
1718 1719 1720 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1718 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
1730 1731 1732 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1730 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. 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
1743 1744 1745 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1743 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
1748 1749 1750 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1748 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
1756 1757 1758 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1756 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
1767 1768 1769 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1767 def query_language_code @query_language_code end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1774 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) @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 |