Class: Google::Apis::JobsV3::SearchJobsResponse
- Inherits:
-
Object
- Object
- Google::Apis::JobsV3::SearchJobsResponse
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/jobs_v3/classes.rb,
generated/google/apis/jobs_v3/representations.rb,
generated/google/apis/jobs_v3/representations.rb
Overview
Output only. Response for SearchJob method.
Instance Attribute Summary collapse
-
#broadened_query_jobs_count ⇒ Fixnum
If query broadening is enabled, we may append additional results from the broadened query.
-
#estimated_total_size ⇒ Fixnum
An estimation of the number of jobs that match the specified query.
-
#histogram_results ⇒ Google::Apis::JobsV3::HistogramResults
Output only.
-
#location_filters ⇒ Array<Google::Apis::JobsV3::Location>
The location filters that the service applied to the specified query.
-
#matching_jobs ⇒ Array<Google::Apis::JobsV3::MatchingJob>
The Job entities that match the specified SearchJobsRequest.
-
#metadata ⇒ Google::Apis::JobsV3::ResponseMetadata
Output only.
-
#next_page_token ⇒ String
The token that specifies the starting position of the next page of results.
-
#spell_correction ⇒ Google::Apis::JobsV3::SpellingCorrection
Output only.
-
#total_size ⇒ Fixnum
The precise result count, which is available only if the client set enable_precise_result_size to
true
, or if the response is the last page of results.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SearchJobsResponse
constructor
A new instance of SearchJobsResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SearchJobsResponse
Returns a new instance of SearchJobsResponse.
2674 2675 2676 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2674 def initialize(**args) update!(**args) end |
Instance Attribute Details
#broadened_query_jobs_count ⇒ Fixnum
If query broadening is enabled, we may append additional results from the
broadened query. This number indicates how many of the jobs returned in the
jobs field are from the broadened query. These results are always at the
end of the jobs list. In particular, a value of 0, or if the field isn't
set, all the jobs in the jobs list are from the original
(without broadening) query. If this field is non-zero, subsequent requests
with offset after this result set should contain all broadened results.
Corresponds to the JSON property broadenedQueryJobsCount
2621 2622 2623 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2621 def broadened_query_jobs_count @broadened_query_jobs_count end |
#estimated_total_size ⇒ Fixnum
An estimation of the number of jobs that match the specified query.
This number is not guaranteed to be accurate. For accurate results,
see enable_precise_result_size.
Corresponds to the JSON property estimatedTotalSize
2628 2629 2630 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2628 def estimated_total_size @estimated_total_size end |
#histogram_results ⇒ Google::Apis::JobsV3::HistogramResults
Output only.
Histogram results that match HistogramFacets specified in
SearchJobsRequest.
Corresponds to the JSON property histogramResults
2635 2636 2637 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2635 def histogram_results @histogram_results end |
#location_filters ⇒ Array<Google::Apis::JobsV3::Location>
The location filters that the service applied to the specified query. If
any filters are lat-lng based, the JobLocation.location_type is
JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.
Corresponds to the JSON property locationFilters
2642 2643 2644 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2642 def location_filters @location_filters end |
#matching_jobs ⇒ Array<Google::Apis::JobsV3::MatchingJob>
The Job entities that match the specified SearchJobsRequest.
Corresponds to the JSON property matchingJobs
2647 2648 2649 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2647 def matching_jobs @matching_jobs end |
#metadata ⇒ Google::Apis::JobsV3::ResponseMetadata
Output only.
Additional information returned to client, such as debugging information.
Corresponds to the JSON property metadata
2653 2654 2655 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2653 def @metadata end |
#next_page_token ⇒ String
The token that specifies the starting position of the next page of results.
This field is empty if there are no more results.
Corresponds to the JSON property nextPageToken
2659 2660 2661 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2659 def next_page_token @next_page_token end |
#spell_correction ⇒ Google::Apis::JobsV3::SpellingCorrection
Output only.
Spell check result.
Corresponds to the JSON property spellCorrection
2665 2666 2667 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2665 def spell_correction @spell_correction end |
#total_size ⇒ Fixnum
The precise result count, which is available only if the client set
enable_precise_result_size to true
, or if the response
is the last page of results. Otherwise, the value is -1
.
Corresponds to the JSON property totalSize
2672 2673 2674 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2672 def total_size @total_size end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 |
# File 'generated/google/apis/jobs_v3/classes.rb', line 2679 def update!(**args) @broadened_query_jobs_count = args[:broadened_query_jobs_count] if args.key?(:broadened_query_jobs_count) @estimated_total_size = args[:estimated_total_size] if args.key?(:estimated_total_size) @histogram_results = args[:histogram_results] if args.key?(:histogram_results) @location_filters = args[:location_filters] if args.key?(:location_filters) @matching_jobs = args[:matching_jobs] if args.key?(:matching_jobs) @metadata = args[:metadata] if args.key?(:metadata) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @spell_correction = args[:spell_correction] if args.key?(:spell_correction) @total_size = args[:total_size] if args.key?(:total_size) end |