Class: Google::Apis::CloudsearchV1::SuggestRequest

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

Request of suggest API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SuggestRequest

Returns a new instance of SuggestRequest.



4543
4544
4545
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4543

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

Instance Attribute Details

#data_source_restrictions ⇒ Array<Google::Apis::CloudsearchV1::DataSourceRestriction>

The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are supported only for third party data sources and people (i.e. PredefinedSource.PERSON). Corresponds to the JSON property dataSourceRestrictions

Returns:



4529
4530
4531
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4529

def data_source_restrictions
  @data_source_restrictions
end

#query ⇒ String

Partial query for which autocomplete suggestions will be shown. For example, if the query is "sea", then the server might return "season", "search", " seagull" and so on. Corresponds to the JSON property query

Returns:

  • (String) 


4536
4537
4538
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4536

def query
  @query
end

#request_options ⇒ Google::Apis::CloudsearchV1::RequestOptions

Shared request options for all RPC methods. Corresponds to the JSON property requestOptions

Returns:



4541
4542
4543
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4541

def request_options
  @request_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4548
4549
4550
4551
4552
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4548

def update!(**args)
  @data_source_restrictions = args[:data_source_restrictions] if args.key?(:data_source_restrictions)
  @query = args[:query] if args.key?(:query)
  @request_options = args[:request_options] if args.key?(:request_options)
end