Class: Google::Apis::JobsV3p1beta1::SearchJobsResponse

Inherits:
Object
  • Object
show all
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

Output only. Response for SearchJob 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) ⇒ SearchJobsResponse

Returns a new instance of SearchJobsResponse



2954
2955
2956
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2954

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

Returns:

  • (Fixnum) 


2895
2896
2897
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2895

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

Returns:

  • (Fixnum) 


2902
2903
2904
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2902

def estimated_total_size
  @estimated_total_size
end

#histogram_query_results ⇒ Array<Google::Apis::JobsV3p1beta1::HistogramQueryResult>

The histogram results that match with specified SearchJobsRequest.histogram_queries. Corresponds to the JSON property histogramQueryResults

Returns:



2908
2909
2910
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2908

def histogram_query_results
  @histogram_query_results
end

#histogram_results ⇒ Google::Apis::JobsV3p1beta1::HistogramResults

Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. Corresponds to the JSON property histogramResults

Returns:



2915
2916
2917
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2915

def histogram_results
  @histogram_results
end

#location_filters ⇒ Array<Google::Apis::JobsV3p1beta1::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

Returns:



2922
2923
2924
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2922

def location_filters
  @location_filters
end

#matching_jobs ⇒ Array<Google::Apis::JobsV3p1beta1::MatchingJob>

The Job entities that match the specified SearchJobsRequest. Corresponds to the JSON property matchingJobs

Returns:



2927
2928
2929
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2927

def matching_jobs
  @matching_jobs
end

#metadata ⇒ Google::Apis::JobsV3p1beta1::ResponseMetadata

Output only. Additional information returned to client, such as debugging information. Corresponds to the JSON property metadata

Returns:



2933
2934
2935
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2933

def metadata
  @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

Returns:

  • (String) 


2939
2940
2941
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2939

def next_page_token
  @next_page_token
end

#spell_correction ⇒ Google::Apis::JobsV3p1beta1::SpellingCorrection

Output only. Spell check result. Corresponds to the JSON property spellCorrection

Returns:



2945
2946
2947
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2945

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

Returns:

  • (Fixnum) 


2952
2953
2954
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2952

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2959

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_query_results = args[:histogram_query_results] if args.key?(:histogram_query_results)
  @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