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

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

Overview

The search API response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchResponse

Returns a new instance of SearchResponse.



18227
18228
18229
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18227

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:



18172
18173
18174
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18172

def debug_info
  @debug_info
end

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

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

Returns:



18177
18178
18179
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18177

def error_info
  @error_info
end

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

Repeated facet results. Corresponds to the JSON property facetResults

Returns:



18182
18183
18184
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18182

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) 


18187
18188
18189
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18187

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:



18194
18195
18196
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18194

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) 


18199
18200
18201
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18199

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) 


18204
18205
18206
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18204

def result_count_exact
  @result_count_exact
end

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

Result count information Corresponds to the JSON property resultCounts

Returns:



18209
18210
18211
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18209

def result_counts
  @result_counts
end

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

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

Returns:



18214
18215
18216
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18214

def results
  @results
end

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

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

Returns:



18219
18220
18221
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18219

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:



18225
18226
18227
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18225

def structured_results
  @structured_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
18243
18244
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18232

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