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.



15149
15150
15151
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15149

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:



15120
15121
15122
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15120

def clustered_results
  @clustered_results
end

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

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

Returns:



15125
15126
15127
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15125

def debug_info
  @debug_info
end

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

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

Returns:



15130
15131
15132
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15130

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:



15136
15137
15138
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15136

def snippet
  @snippet
end

#title ⇒ String

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

Returns:

  • (String) 


15141
15142
15143
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15141

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) 


15147
15148
15149
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15147

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15154
15155
15156
15157
15158
15159
15160
15161
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15154

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