Class: Google::Apis::CloudsearchV1::SuggestResult

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

One suggestion result.

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) ⇒ SuggestResult

Returns a new instance of SuggestResult



4823
4824
4825
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4823

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#people_suggestion ⇒ Google::Apis::CloudsearchV1::PeopleSuggestion

This field contains information about the person being suggested. Corresponds to the JSON property peopleSuggestion

Returns:



4804
4805
4806
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4804

def people_suggestion
  @people_suggestion
end

#query_suggestion ⇒ Google::Apis::CloudsearchV1::QuerySuggestion

This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion. Corresponds to the JSON property querySuggestion

Returns:



4810
4811
4812
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4810

def query_suggestion
  @query_suggestion
end

#source ⇒ Google::Apis::CloudsearchV1::Source

Defines sources for the suggest/search APIs. Corresponds to the JSON property source

Returns:



4815
4816
4817
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4815

def source
  @source
end

#suggested_query ⇒ String

The suggested query that will be used for search, when the user clicks on the suggestion Corresponds to the JSON property suggestedQuery

Returns:

  • (String) 


4821
4822
4823
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4821

def suggested_query
  @suggested_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4828
4829
4830
4831
4832
4833
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4828

def update!(**args)
  @people_suggestion = args[:people_suggestion] if args.key?(:people_suggestion)
  @query_suggestion = args[:query_suggestion] if args.key?(:query_suggestion)
  @source = args[:source] if args.key?(:source)
  @suggested_query = args[:suggested_query] if args.key?(:suggested_query)
end