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



3869
3870
3871
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3869

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:



3841
3842
3843
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3841

def clustered_results
  @clustered_results
end

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

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

Returns:



3846
3847
3848
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3846

def debug_info
  @debug_info
end

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

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

Returns:



3851
3852
3853
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3851

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:



3857
3858
3859
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3857

def snippet
  @snippet
end

#title ⇒ String

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

Returns:

  • (String) 


3862
3863
3864
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3862

def title
  @title
end

#url ⇒ String

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

Returns:

  • (String) 


3867
3868
3869
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3867

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3874
3875
3876
3877
3878
3879
3880
3881
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3874

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