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

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



2775
2776
2777
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2775

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

Instance Attribute Details

#broadened_query_jobs_countFixnum

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)


2716
2717
2718
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2716

def broadened_query_jobs_count
  @broadened_query_jobs_count
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, see enable_precise_result_size. Corresponds to the JSON property estimatedTotalSize

Returns:

  • (Fixnum)


2723
2724
2725
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2723

def estimated_total_size
  @estimated_total_size
end

#histogram_query_resultsArray<Google::Apis::JobsV3p1beta1::HistogramQueryResult>

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



2729
2730
2731
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2729

def histogram_query_results
  @histogram_query_results
end

#histogram_resultsGoogle::Apis::JobsV3p1beta1::HistogramResults

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



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

def histogram_results
  @histogram_results
end

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



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

def location_filters
  @location_filters
end

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

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



2748
2749
2750
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2748

def matching_jobs
  @matching_jobs
end

#metadataGoogle::Apis::JobsV3p1beta1::ResponseMetadata

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



2754
2755
2756
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2754

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)


2760
2761
2762
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2760

def next_page_token
  @next_page_token
end

#spell_correctionGoogle::Apis::JobsV3p1beta1::SpellingCorrection

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



2766
2767
2768
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2766

def spell_correction
  @spell_correction
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 is -1. Corresponds to the JSON property totalSize

Returns:

  • (Fixnum)


2773
2774
2775
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2773

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2780

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