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.



3370
3371
3372
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3370

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:



3300
3301
3302
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3300

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:



3307
3308
3309
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3307

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) 


3314
3315
3316
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3314

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:



3321
3322
3323
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3321

def histogram_results
  @histogram_results
end

#job_view ⇒ String

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

Returns:

  • (String) 


3326
3327
3328
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3326

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:



3331
3332
3333
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3331

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:



3338
3339
3340
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3338

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) 


3344
3345
3346
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3344

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) 


3355
3356
3357
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3355

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:



3361
3362
3363
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3361

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) 


3368
3369
3370
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3368

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3375

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