Class: Google::Apis::JobsV2::GetHistogramRequest
- Inherits:
-
Object
- Object
- Google::Apis::JobsV2::GetHistogramRequest
- 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
Deprecated. Use SearchJobsRequest.histogram_facets instead to make
a single call with both search and histogram.
Input only.
A request for the GetHistogram
method.
Instance Attribute Summary collapse
-
#allow_broadening ⇒ Boolean
(also: #allow_broadening?)
Optional.
-
#filters ⇒ Google::Apis::JobsV2::JobFilters
Input only.
-
#query ⇒ Google::Apis::JobsV2::JobQuery
Input only.
-
#request_metadata ⇒ Google::Apis::JobsV2::RequestMetadata
Input only.
-
#search_types ⇒ Array<String>
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GetHistogramRequest
constructor
A new instance of GetHistogramRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GetHistogramRequest
Returns a new instance of GetHistogramRequest
1386 1387 1388 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1386 def initialize(**args) update!(**args) end |
Instance Attribute Details
#allow_broadening ⇒ Boolean Also known as: allow_broadening?
Optional.
Controls whether to broaden the search to avoid too few results for a
given query in instances where a search has sparse results. Results from a
broadened query is a superset of the results from the original query.
Defaults to false.
Corresponds to the JSON property allowBroadening
1352 1353 1354 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1352 def allow_broadening @allow_broadening end |
#filters ⇒ Google::Apis::JobsV2::JobFilters
Input only.
Deprecated. Use JobQuery instead.
The filters required to perform a search query or histogram.
Corresponds to the JSON property filters
1360 1361 1362 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1360 def filters @filters end |
#query ⇒ Google::Apis::JobsV2::JobQuery
Input only.
The query required to perform a search query or histogram.
Corresponds to the JSON property query
1366 1367 1368 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1366 def query @query end |
#request_metadata ⇒ Google::Apis::JobsV2::RequestMetadata
Input only.
Meta information related to the job searcher or entity
conducting the job search. This information is used to improve the
performance of the service.
Corresponds to the JSON property requestMetadata
1374 1375 1376 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1374 def @request_metadata end |
#search_types ⇒ Array<String>
Required.
A list of facets that specify the histogram data to be calculated
against and returned.
Histogram response times can be slow, and counts
can be approximations. This call may be temporarily or permanently removed
prior to the production release of Cloud Job Discovery.
Corresponds to the JSON property searchTypes
1384 1385 1386 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1384 def search_types @search_types end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1391 1392 1393 1394 1395 1396 1397 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1391 def update!(**args) @allow_broadening = args[:allow_broadening] if args.key?(:allow_broadening) @filters = args[:filters] if args.key?(:filters) @query = args[:query] if args.key?(:query) @request_metadata = args[:request_metadata] if args.key?(:request_metadata) @search_types = args[:search_types] if args.key?(:search_types) end |