Class: Google::Apis::JobsV2::GetHistogramRequest

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

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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GetHistogramRequest

Returns a new instance of GetHistogramRequest.



1359
1360
1361
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1359

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

Returns:

  • (Boolean) 


1326
1327
1328
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1326

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

Returns:



1334
1335
1336
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1334

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

Returns:



1340
1341
1342
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1340

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

Returns:



1348
1349
1350
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1348

def request_metadata
  @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 Talent Solution. Corresponds to the JSON property searchTypes

Returns:

  • (Array<String>) 


1357
1358
1359
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1357

def search_types
  @search_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1364
1365
1366
1367
1368
1369
1370
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1364

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