Class: Google::Apis::JobsV2::SearchJobsResponse

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

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



3289
3290
3291
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3289

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#applied_commute_filter ⇒ Google::Apis::JobsV2::CommutePreference

Input only. Parameters needed for commute search. Corresponds to the JSON property appliedCommuteFilter

Returns:



3219
3220
3221
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3219

def applied_commute_filter
  @applied_commute_filter
end

#applied_job_location_filters ⇒ Array<Google::Apis::JobsV2::JobLocation>

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 appliedJobLocationFilters

Returns:



3226
3227
3228
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3226

def applied_job_location_filters
  @applied_job_location_filters
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, seenenable_precise_result_size. Corresponds to the JSON property estimatedTotalSize

Returns:

  • (Fixnum) 


3233
3234
3235
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3233

def estimated_total_size
  @estimated_total_size
end

#histogram_results ⇒ Google::Apis::JobsV2::HistogramResults

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

Returns:



3240
3241
3242
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3240

def histogram_results
  @histogram_results
end

#job_view ⇒ String

Corresponds to SearchJobsRequest.job_view. Corresponds to the JSON property jobView

Returns:

  • (String) 


3245
3246
3247
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3245

def job_view
  @job_view
end

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

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

Returns:



3250
3251
3252
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3250

def matching_jobs
  @matching_jobs
end

#metadata ⇒ Google::Apis::JobsV2::ResponseMetadata

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

Returns:



3257
3258
3259
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3257

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) 


3263
3264
3265
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3263

def next_page_token
  @next_page_token
end

#num_jobs_from_broadened_query ⇒ 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 means 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 numJobsFromBroadenedQuery

Returns:

  • (Fixnum) 


3274
3275
3276
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3274

def num_jobs_from_broadened_query
  @num_jobs_from_broadened_query
end

#spell_result ⇒ Google::Apis::JobsV2::SpellingCorrection

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

Returns:



3280
3281
3282
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3280

def spell_result
  @spell_result
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 will be -1. Corresponds to the JSON property totalSize

Returns:

  • (Fixnum) 


3287
3288
3289
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3287

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3294

def update!(**args)
  @applied_commute_filter = args[:applied_commute_filter] if args.key?(:applied_commute_filter)
  @applied_job_location_filters = args[:applied_job_location_filters] if args.key?(:applied_job_location_filters)
  @estimated_total_size = args[:estimated_total_size] if args.key?(:estimated_total_size)
  @histogram_results = args[:histogram_results] if args.key?(:histogram_results)
  @job_view = args[:job_view] if args.key?(:job_view)
  @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)
  @num_jobs_from_broadened_query = args[:num_jobs_from_broadened_query] if args.key?(:num_jobs_from_broadened_query)
  @spell_result = args[:spell_result] if args.key?(:spell_result)
  @total_size = args[:total_size] if args.key?(:total_size)
end