Class: Google::Apis::JobsV4::SearchJobsResponse

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

Overview

Response for SearchJob method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchJobsResponse

Returns a new instance of SearchJobsResponse.



2557
2558
2559
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2557

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) 


2515
2516
2517
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2515

def broadened_query_jobs_count
  @broadened_query_jobs_count
end

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

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

Returns:



2521
2522
2523
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2521

def histogram_query_results
  @histogram_query_results
end

#location_filters ⇒ Array<Google::Apis::JobsV4::Location>

The location filters that the service applied to the specified query. If any filters are lat-lng based, the Location.location_type is Location.LocationType. LOCATION_TYPE_UNSPECIFIED. Corresponds to the JSON property locationFilters

Returns:



2528
2529
2530
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2528

def location_filters
  @location_filters
end

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

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

Returns:



2533
2534
2535
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2533

def matching_jobs
  @matching_jobs
end

#metadata ⇒ Google::Apis::JobsV4::ResponseMetadata

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

Returns:



2538
2539
2540
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2538

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) 


2544
2545
2546
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2544

def next_page_token
  @next_page_token
end

#spell_correction ⇒ Google::Apis::JobsV4::SpellingCorrection

Spell check result. Corresponds to the JSON property spellCorrection

Returns:



2549
2550
2551
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2549

def spell_correction
  @spell_correction
end

#total_size ⇒ Fixnum

Number of jobs that match the specified query. Note: This size is precise only if the total is less than 100,000. Corresponds to the JSON property totalSize

Returns:

  • (Fixnum) 


2555
2556
2557
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2555

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2562

def update!(**args)
  @broadened_query_jobs_count = args[:broadened_query_jobs_count] if args.key?(:broadened_query_jobs_count)
  @histogram_query_results = args[:histogram_query_results] if args.key?(:histogram_query_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