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.



18147
18148
18149
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18147

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:



18101
18102
18103
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18101

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:



18107
18108
18109
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18107

def data_source_restrictions
  @data_source_restrictions
end

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

Corresponds to the JSON property facetOptions

Returns:



18112
18113
18114
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18112

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) 


18119
18120
18121
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18119

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) 


18125
18126
18127
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18125

def query
  @query
end

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

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

Returns:



18130
18131
18132
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18130

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:



18135
18136
18137
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18135

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:



18140
18141
18142
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18140

def sort_options
  @sort_options
end

#start ⇒ Fixnum

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

Returns:

  • (Fixnum) 


18145
18146
18147
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18145

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 18152

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