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.
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
1753 1754 1755 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1753 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
1627 1628 1629 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1627 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
1638 1639 1640 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1638 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
1650 1651 1652 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1650 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
1656 1657 1658 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1656 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
1677 1678 1679 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1677 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
1685 1686 1687 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1685 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
1696 1697 1698 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1696 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
1703 1704 1705 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1703 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
1713 1714 1715 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1713 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
1725 1726 1727 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1725 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
1738 1739 1740 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1738 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
1743 1744 1745 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1743 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
1751 1752 1753 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1751 def query @query end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 |
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1758 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) end |