Class: Google::Apis::CloudsearchV1::SearchResult

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

Results containing indexed information for a document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchResult

Returns a new instance of SearchResult.



7253
7254
7255
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7253

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

Instance Attribute Details

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

If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty. Corresponds to the JSON property clusteredResults

Returns:



7224
7225
7226
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7224

def clustered_results
  @clustered_results
end

#debug_info ⇒ Google::Apis::CloudsearchV1::ResultDebugInfo

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

Returns:



7229
7230
7231
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7229

def debug_info
  @debug_info
end

#metadata ⇒ Google::Apis::CloudsearchV1::Metadata

Metadata of a matched search result. Corresponds to the JSON property metadata

Returns:



7234
7235
7236
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7234

def metadata
  @metadata
end

#snippet ⇒ Google::Apis::CloudsearchV1::Snippet

Snippet of the search result, which summarizes the content of the resulting page. Corresponds to the JSON property snippet

Returns:



7240
7241
7242
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7240

def snippet
  @snippet
end

#title ⇒ String

Title of the search result. Corresponds to the JSON property title

Returns:

  • (String) 


7245
7246
7247
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7245

def title
  @title
end

#url ⇒ String

The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed. Corresponds to the JSON property url

Returns:

  • (String) 


7251
7252
7253
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7251

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7258
7259
7260
7261
7262
7263
7264
7265
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7258

def update!(**args)
  @clustered_results = args[:clustered_results] if args.key?(:clustered_results)
  @debug_info = args[:debug_info] if args.key?(:debug_info)
  @metadata = args[:metadata] if args.key?(:metadata)
  @snippet = args[:snippet] if args.key?(:snippet)
  @title = args[:title] if args.key?(:title)
  @url = args[:url] if args.key?(:url)
end