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.



15786
15787
15788
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15786

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:



15757
15758
15759
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15757

def clustered_results
  @clustered_results
end

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

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

Returns:



15762
15763
15764
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15762

def debug_info
  @debug_info
end

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

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

Returns:



15767
15768
15769
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15767

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:



15773
15774
15775
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15773

def snippet
  @snippet
end

#title ⇒ String

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

Returns:

  • (String) 


15778
15779
15780
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15778

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) 


15784
15785
15786
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15784

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15791
15792
15793
15794
15795
15796
15797
15798
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15791

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