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



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

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

Instance Attribute Details

#applied_commute_filterGoogle::Apis::JobsV2::CommutePreference

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



3170
3171
3172
# File 'generated/google/apis/jobs_v2/classes.rb', line 3170

def applied_commute_filter
  @applied_commute_filter
end

#applied_job_location_filtersArray<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



3177
3178
3179
# File 'generated/google/apis/jobs_v2/classes.rb', line 3177

def applied_job_location_filters
  @applied_job_location_filters
end

#estimated_total_sizeFixnum

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)


3184
3185
3186
# File 'generated/google/apis/jobs_v2/classes.rb', line 3184

def estimated_total_size
  @estimated_total_size
end

#histogram_resultsGoogle::Apis::JobsV2::HistogramResults

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



3191
3192
3193
# File 'generated/google/apis/jobs_v2/classes.rb', line 3191

def histogram_results
  @histogram_results
end

#job_viewString

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

Returns:

  • (String)


3196
3197
3198
# File 'generated/google/apis/jobs_v2/classes.rb', line 3196

def job_view
  @job_view
end

#matching_jobsArray<Google::Apis::JobsV2::MatchingJob>

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



3201
3202
3203
# File 'generated/google/apis/jobs_v2/classes.rb', line 3201

def matching_jobs
  @matching_jobs
end

#metadataGoogle::Apis::JobsV2::ResponseMetadata

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



3208
3209
3210
# File 'generated/google/apis/jobs_v2/classes.rb', line 3208

def 
  @metadata
end

#next_page_tokenString

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)


3214
3215
3216
# File 'generated/google/apis/jobs_v2/classes.rb', line 3214

def next_page_token
  @next_page_token
end

#num_jobs_from_broadened_queryFixnum

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)


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

def num_jobs_from_broadened_query
  @num_jobs_from_broadened_query
end

#spell_resultGoogle::Apis::JobsV2::SpellingCorrection

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



3231
3232
3233
# File 'generated/google/apis/jobs_v2/classes.rb', line 3231

def spell_result
  @spell_result
end

#total_sizeFixnum

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)


3238
3239
3240
# File 'generated/google/apis/jobs_v2/classes.rb', line 3238

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
# File 'generated/google/apis/jobs_v2/classes.rb', line 3245

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