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

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

The search API request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchRequest

Returns a new instance of SearchRequest.



4146
4147
4148
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4146

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

Instance Attribute Details

#data_source_restrictionsArray<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



4103
4104
4105
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4103

def data_source_restrictions
  @data_source_restrictions
end

#facet_optionsArray<Google::Apis::CloudsearchV1::FacetOptions>

Corresponds to the JSON property facetOptions



4108
4109
4110
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4108

def facet_options
  @facet_options
end

#page_sizeFixnum

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

Returns:

  • (Fixnum)


4115
4116
4117
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4115

def page_size
  @page_size
end

#queryString

The raw query string. See supported search operators in the Cloud search Cheat Sheet Corresponds to the JSON property query

Returns:

  • (String)


4124
4125
4126
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4124

def query
  @query
end

#query_interpretation_optionsGoogle::Apis::CloudsearchV1::QueryInterpretationOptions

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



4129
4130
4131
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4129

def query_interpretation_options
  @query_interpretation_options
end

#request_optionsGoogle::Apis::CloudsearchV1::RequestOptions

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



4134
4135
4136
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4134

def request_options
  @request_options
end

#sort_optionsGoogle::Apis::CloudsearchV1::SortOptions

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



4139
4140
4141
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4139

def sort_options
  @sort_options
end

#startFixnum

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

Returns:

  • (Fixnum)


4144
4145
4146
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4144

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4151

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