class Google::Apis::CloudsearchV1::SearchRequest

The search API request.

Attributes

context_attributes[RW]

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` @return [Array<Google::Apis::CloudsearchV1::ContextAttribute>]

data_source_restrictions[RW]

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` @return [Array<Google::Apis::CloudsearchV1::DataSourceRestriction>]

facet_options[RW]

Corresponds to the JSON property `facetOptions` @return [Array<Google::Apis::CloudsearchV1::FacetOptions>]

page_size[RW]

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` @return [Fixnum]

query[RW]

The raw query string. See supported search operators in the [Cloud search Cheat Sheet](support.google.com/a/users/answer/9299929) Corresponds to the JSON property `query` @return [String]

query_interpretation_options[RW]

Options to interpret user query. Corresponds to the JSON property `queryInterpretationOptions` @return [Google::Apis::CloudsearchV1::QueryInterpretationOptions]

request_options[RW]

Shared request options for all RPC methods. Corresponds to the JSON property `requestOptions` @return [Google::Apis::CloudsearchV1::RequestOptions]

sort_options[RW]

The options for sorting the search results Corresponds to the JSON property `sortOptions` @return [Google::Apis::CloudsearchV1::SortOptions]

start[RW]

Starting index of the results. Corresponds to the JSON property `start` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudsearch_v1/classes.rb, line 4220
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudsearch_v1/classes.rb, line 4225
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