Class: Google::Apis::CloudsearchV1::SearchResponse

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb

Overview

The search API response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchResponse

Returns a new instance of SearchResponse



3983
3984
3985
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3983

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

Instance Attribute Details

#debug_info ⇒ Google::Apis::CloudsearchV1::ResponseDebugInfo

Debugging information about the response. Corresponds to the JSON property debugInfo

Returns:



3928
3929
3930
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3928

def debug_info
  @debug_info
end

#error_info ⇒ Google::Apis::CloudsearchV1::ErrorInfo

Error information about the response. Corresponds to the JSON property errorInfo

Returns:



3933
3934
3935
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3933

def error_info
  @error_info
end

#facet_results ⇒ Array<Google::Apis::CloudsearchV1::FacetResult>

Repeated facet results. Corresponds to the JSON property facetResults

Returns:



3938
3939
3940
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3938

def facet_results
  @facet_results
end

#has_more_results ⇒ Boolean Also known as: has_more_results?

Whether there are more search results matching the query. Corresponds to the JSON property hasMoreResults

Returns:

  • (Boolean) 


3943
3944
3945
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3943

def has_more_results
  @has_more_results
end

#query_interpretation ⇒ Google::Apis::CloudsearchV1::QueryInterpretation

Query interpretation result for user query. Empty if query interpretation is disabled. Corresponds to the JSON property queryInterpretation

Returns:



3950
3951
3952
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3950

def query_interpretation
  @query_interpretation
end

#result_count_estimate ⇒ Fixnum

The estimated result count for this query. Corresponds to the JSON property resultCountEstimate

Returns:

  • (Fixnum) 


3955
3956
3957
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3955

def result_count_estimate
  @result_count_estimate
end

#result_count_exact ⇒ Fixnum

The exact result count for this query. Corresponds to the JSON property resultCountExact

Returns:

  • (Fixnum) 


3960
3961
3962
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3960

def result_count_exact
  @result_count_exact
end

#result_counts ⇒ Google::Apis::CloudsearchV1::ResultCounts

Result count information Corresponds to the JSON property resultCounts

Returns:



3965
3966
3967
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3965

def result_counts
  @result_counts
end

#results ⇒ Array<Google::Apis::CloudsearchV1::SearchResult>

Results from a search query. Corresponds to the JSON property results

Returns:



3970
3971
3972
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3970

def results
  @results
end

#spell_results ⇒ Array<Google::Apis::CloudsearchV1::SpellResult>

Suggested spelling for the query. Corresponds to the JSON property spellResults

Returns:



3975
3976
3977
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3975

def spell_results
  @spell_results
end

#structured_results ⇒ Array<Google::Apis::CloudsearchV1::StructuredResult>

Structured results for the user query. These results are not counted against the page_size. Corresponds to the JSON property structuredResults

Returns:



3981
3982
3983
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3981

def structured_results
  @structured_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3988

def update!(**args)
  @debug_info = args[:debug_info] if args.key?(:debug_info)
  @error_info = args[:error_info] if args.key?(:error_info)
  @facet_results = args[:facet_results] if args.key?(:facet_results)
  @has_more_results = args[:has_more_results] if args.key?(:has_more_results)
  @query_interpretation = args[:query_interpretation] if args.key?(:query_interpretation)
  @result_count_estimate = args[:result_count_estimate] if args.key?(:result_count_estimate)
  @result_count_exact = args[:result_count_exact] if args.key?(:result_count_exact)
  @result_counts = args[:result_counts] if args.key?(:result_counts)
  @results = args[:results] if args.key?(:results)
  @spell_results = args[:spell_results] if args.key?(:spell_results)
  @structured_results = args[:structured_results] if args.key?(:structured_results)
end