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.



4225
4226
4227
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4225

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

Instance Attribute Details

#debug_infoGoogle::Apis::CloudsearchV1::ResponseDebugInfo

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



4170
4171
4172
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4170

def debug_info
  @debug_info
end

#error_infoGoogle::Apis::CloudsearchV1::ErrorInfo

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



4175
4176
4177
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4175

def error_info
  @error_info
end

#facet_resultsArray<Google::Apis::CloudsearchV1::FacetResult>

Repeated facet results. Corresponds to the JSON property facetResults



4180
4181
4182
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4180

def facet_results
  @facet_results
end

#has_more_resultsBoolean Also known as: has_more_results?

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

Returns:

  • (Boolean)


4185
4186
4187
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4185

def has_more_results
  @has_more_results
end

#query_interpretationGoogle::Apis::CloudsearchV1::QueryInterpretation

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



4192
4193
4194
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4192

def query_interpretation
  @query_interpretation
end

#result_count_estimateFixnum

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

Returns:

  • (Fixnum)


4197
4198
4199
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4197

def result_count_estimate
  @result_count_estimate
end

#result_count_exactFixnum

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

Returns:

  • (Fixnum)


4202
4203
4204
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4202

def result_count_exact
  @result_count_exact
end

#result_countsGoogle::Apis::CloudsearchV1::ResultCounts

Result count information Corresponds to the JSON property resultCounts



4207
4208
4209
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4207

def result_counts
  @result_counts
end

#resultsArray<Google::Apis::CloudsearchV1::SearchResult>

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



4212
4213
4214
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4212

def results
  @results
end

#spell_resultsArray<Google::Apis::CloudsearchV1::SpellResult>

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



4217
4218
4219
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4217

def spell_results
  @spell_results
end

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



4223
4224
4225
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4223

def structured_results
  @structured_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4230

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