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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchResult

Returns a new instance of SearchResult



4041
4042
4043
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4041

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:



4012
4013
4014
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4012

def clustered_results
  @clustered_results
end

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

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

Returns:



4017
4018
4019
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4017

def debug_info
  @debug_info
end

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

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

Returns:



4022
4023
4024
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4022

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:



4028
4029
4030
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4028

def snippet
  @snippet
end

#title ⇒ String

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

Returns:

  • (String) 


4033
4034
4035
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4033

def title
  @title
end

#url ⇒ String

The URL of the search result. The URL contains a Google redirect to the actual item. Corresponds to the JSON property url

Returns:

  • (String) 


4039
4040
4041
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4039

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4046
4047
4048
4049
4050
4051
4052
4053
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4046

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