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



3793
3794
3795
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3793

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:



3765
3766
3767
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3765

def clustered_results
  @clustered_results
end

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

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

Returns:



3770
3771
3772
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3770

def debug_info
  @debug_info
end

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

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

Returns:



3775
3776
3777
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3775

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:



3781
3782
3783
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3781

def snippet
  @snippet
end

#title ⇒ String

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

Returns:

  • (String) 


3786
3787
3788
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3786

def title
  @title
end

#url ⇒ String

The URL of the result. Corresponds to the JSON property url

Returns:

  • (String) 


3791
3792
3793
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3791

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3798
3799
3800
3801
3802
3803
3804
3805
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3798

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