Class: Google::Apis::JobsV3::SearchJobsResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/jobs_v3/classes.rb,
lib/google/apis/jobs_v3/representations.rb,
lib/google/apis/jobs_v3/representations.rb

Overview

Output only. Response for SearchJob method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchJobsResponse

Returns a new instance of SearchJobsResponse.



2325
2326
2327
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2325

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) 


2276
2277
2278
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2276

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 SearchJobsResponse.total_size. Corresponds to the JSON property estimatedTotalSize

Returns:

  • (Fixnum) 


2283
2284
2285
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2283

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

Returns:



2289
2290
2291
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2289

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

Returns:



2296
2297
2298
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2296

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

Returns:



2301
2302
2303
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2301

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

Returns:



2307
2308
2309
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2307

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) 


2313
2314
2315
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2313

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

Returns:



2318
2319
2320
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2318

def spell_correction
  @spell_correction
end

#total_size ⇒ Fixnum

The precise result count with limit 100,000. Corresponds to the JSON property totalSize

Returns:

  • (Fixnum) 


2323
2324
2325
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2323

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 2330

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