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
3891 3892 3893 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3891 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
3848 3849 3850 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3848 def data_source_restrictions @data_source_restrictions end |
#facet_options ⇒ Array<Google::Apis::CloudsearchV1::FacetOptions>
Corresponds to the JSON property facetOptions
3853 3854 3855 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3853 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
3860 3861 3862 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3860 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
3869 3870 3871 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3869 def query @query end |
#query_interpretation_options ⇒ Google::Apis::CloudsearchV1::QueryInterpretationOptions
Options to interpret user query.
Corresponds to the JSON property queryInterpretationOptions
3874 3875 3876 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3874 def @query_interpretation_options end |
#request_options ⇒ Google::Apis::CloudsearchV1::RequestOptions
Shared request options for all RPC methods.
Corresponds to the JSON property requestOptions
3879 3880 3881 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3879 def @request_options end |
#sort_options ⇒ Google::Apis::CloudsearchV1::SortOptions
The options for sorting the search results
Corresponds to the JSON property sortOptions
3884 3885 3886 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3884 def @sort_options end |
#start ⇒ Fixnum
Starting index of the results.
Corresponds to the JSON property start
3889 3890 3891 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3889 def start @start end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3896 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 |