Class: Google::Apis::CloudsearchV1::SearchRequest
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::SearchRequest
- Defined in:
- generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb
Overview
The search API request.
Instance Attribute Summary collapse
-
#data_source_restrictions ⇒ Array<Google::Apis::CloudsearchV1::DataSourceRestriction>
The sources to use for querying.
-
#facet_options ⇒ Array<Google::Apis::CloudsearchV1::FacetOptions>
Corresponds to the JSON property
facetOptions
. -
#page_size ⇒ Fixnum
Maximum number of search results to return in one page.
-
#query ⇒ String
The raw query string.
-
#query_interpretation_options ⇒ Google::Apis::CloudsearchV1::QueryInterpretationOptions
Options to interpret user query.
-
#request_options ⇒ Google::Apis::CloudsearchV1::RequestOptions
Shared request options for all RPC methods.
-
#sort_options ⇒ Google::Apis::CloudsearchV1::SortOptions
The options for sorting the search results Corresponds to the JSON property
sortOptions
. -
#start ⇒ Fixnum
Starting index of the results.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SearchRequest
constructor
A new instance of SearchRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ SearchRequest
Returns a new instance of SearchRequest.
4142 4143 4144 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4142 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
4099 4100 4101 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4099 def data_source_restrictions @data_source_restrictions end |
#facet_options ⇒ Array<Google::Apis::CloudsearchV1::FacetOptions>
Corresponds to the JSON property facetOptions
4104 4105 4106 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4104 def @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.
Corresponds to the JSON property pageSize
4111 4112 4113 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4111 def page_size @page_size end |
#query ⇒ String
The raw query string.
See supported search operators in the Cloud search
Cheat
Sheet
Corresponds to the JSON property query
4120 4121 4122 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4120 def query @query end |
#query_interpretation_options ⇒ Google::Apis::CloudsearchV1::QueryInterpretationOptions
Options to interpret user query.
Corresponds to the JSON property queryInterpretationOptions
4125 4126 4127 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4125 def @query_interpretation_options end |
#request_options ⇒ Google::Apis::CloudsearchV1::RequestOptions
Shared request options for all RPC methods.
Corresponds to the JSON property requestOptions
4130 4131 4132 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4130 def @request_options end |
#sort_options ⇒ Google::Apis::CloudsearchV1::SortOptions
The options for sorting the search results
Corresponds to the JSON property sortOptions
4135 4136 4137 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4135 def @sort_options end |
#start ⇒ Fixnum
Starting index of the results.
Corresponds to the JSON property start
4140 4141 4142 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4140 def start @start end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4147 def update!(**args) @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 |