Class: Google::Apis::JobsV3p1beta1::SearchJobsResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/jobs_v3p1beta1/classes.rb,
lib/google/apis/jobs_v3p1beta1/representations.rb,
lib/google/apis/jobs_v3p1beta1/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.



2743
2744
2745
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2743

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) 


2688
2689
2690
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2688

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) 


2695
2696
2697
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2695

def estimated_total_size
  @estimated_total_size
end

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

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

Returns:



2701
2702
2703
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2701

def histogram_query_results
  @histogram_query_results
end

#histogram_results ⇒ Google::Apis::JobsV3p1beta1::HistogramResults

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

Returns:



2707
2708
2709
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2707

def histogram_results
  @histogram_results
end

#location_filters ⇒ Array<Google::Apis::JobsV3p1beta1::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:



2714
2715
2716
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2714

def location_filters
  @location_filters
end

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

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

Returns:



2719
2720
2721
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2719

def matching_jobs
  @matching_jobs
end

#metadata ⇒ Google::Apis::JobsV3p1beta1::ResponseMetadata

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

Returns:



2725
2726
2727
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2725

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) 


2731
2732
2733
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2731

def next_page_token
  @next_page_token
end

#spell_correction ⇒ Google::Apis::JobsV3p1beta1::SpellingCorrection

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

Returns:



2736
2737
2738
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2736

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) 


2741
2742
2743
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2741

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
 
# File 'lib/google/apis/jobs_v3p1beta1/classes.rb', line 2748

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_query_results = args[:histogram_query_results] if args.key?(:histogram_query_results)
  @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