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.



4892
4893
4894
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4892

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:



4863
4864
4865
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4863

def clustered_results
  @clustered_results
end

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

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

Returns:



4868
4869
4870
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4868

def debug_info
  @debug_info
end

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

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

Returns:



4873
4874
4875
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4873

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:



4879
4880
4881
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4879

def snippet
  @snippet
end

#title ⇒ String

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

Returns:

  • (String) 


4884
4885
4886
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4884

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) 


4890
4891
4892
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4890

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4897
4898
4899
4900
4901
4902
4903
4904
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4897

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