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

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

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.



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

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:



4151
4152
4153
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4151

def clustered_results
  @clustered_results
end

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

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

Returns:



4156
4157
4158
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4156

def debug_info
  @debug_info
end

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

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

Returns:



4161
4162
4163
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4161

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:



4167
4168
4169
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4167

def snippet
  @snippet
end

#title ⇒ String

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

Returns:

  • (String) 


4172
4173
4174
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4172

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) 


4178
4179
4180
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4178

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4185
4186
4187
4188
4189
4190
4191
4192
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4185

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