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



3871
3872
3873
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3871

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:



3843
3844
3845
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3843

def clustered_results
  @clustered_results
end

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

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

Returns:



3848
3849
3850
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3848

def debug_info
  @debug_info
end

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

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

Returns:



3853
3854
3855
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3853

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:



3859
3860
3861
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3859

def snippet
  @snippet
end

#title ⇒ String

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

Returns:

  • (String) 


3864
3865
3866
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3864

def title
  @title
end

#url ⇒ String

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

Returns:

  • (String) 


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

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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