Class: Google::Apis::CloudsearchV1::SearchRequest

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

The search API request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchRequest

Returns a new instance of SearchRequest.



18309
18310
18311
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18309

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

Instance Attribute Details

#context_attributes ⇒ Array<Google::Apis::CloudsearchV1::ContextAttribute>

Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10. Corresponds to the JSON property contextAttributes

Returns:



18263
18264
18265
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18263

def context_attributes
  @context_attributes
end

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

The sources to use for querying. If not specified, all data sources from the current search application are used. Corresponds to the JSON property dataSourceRestrictions

Returns:



18269
18270
18271
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18269

def data_source_restrictions
  @data_source_restrictions
end

#facet_options ⇒ Array<Google::Apis::CloudsearchV1::FacetOptions>

Corresponds to the JSON property facetOptions

Returns:



18274
18275
18276
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18274

def facet_options
  @facet_options
end

#page_size ⇒ Fixnum

Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


18281
18282
18283
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18281

def page_size
  @page_size
end

#query ⇒ String

The raw query string. See supported search operators in the Narrow your search with operators Corresponds to the JSON property query

Returns:

  • (String) 


18287
18288
18289
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18287

def query
  @query
end

#query_interpretation_options ⇒ Google::Apis::CloudsearchV1::QueryInterpretationOptions

Options to interpret user query. Corresponds to the JSON property queryInterpretationOptions

Returns:



18292
18293
18294
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18292

def query_interpretation_options
  @query_interpretation_options
end

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

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

Returns:



18297
18298
18299
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18297

def request_options
  @request_options
end

#sort_options ⇒ Google::Apis::CloudsearchV1::SortOptions

The options for sorting the search results Corresponds to the JSON property sortOptions

Returns:



18302
18303
18304
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18302

def sort_options
  @sort_options
end

#start ⇒ Fixnum

Starting index of the results. Corresponds to the JSON property start

Returns:

  • (Fixnum) 


18307
18308
18309
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18307

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18314

def update!(**args)
  @context_attributes = args[:context_attributes] if args.key?(:context_attributes)
  @data_source_restrictions = args[:data_source_restrictions] if args.key?(:data_source_restrictions)
  @facet_options = args[:facet_options] if args.key?(:facet_options)
  @page_size = args[:page_size] if args.key?(:page_size)
  @query = args[:query] if args.key?(:query)
  @query_interpretation_options = args[:query_interpretation_options] if args.key?(:query_interpretation_options)
  @request_options = args[:request_options] if args.key?(:request_options)
  @sort_options = args[:sort_options] if args.key?(:sort_options)
  @start = args[:start] if args.key?(:start)
end