GoogleApi.CloudSearch.V1.Model.SearchRequest (google_api_cloud_search v0.14.0) View Source

The search API request.

Attributes

contextAttributes (type: list(GoogleApi.CloudSearch.V1.Model.ContextAttribute.t), default: nil) - Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.
dataSourceRestrictions (type: list(GoogleApi.CloudSearch.V1.Model.DataSourceRestriction.t), default: nil) - The sources to use for querying. If not specified, all data sources from the current search application are used.
facetOptions (type: list(GoogleApi.CloudSearch.V1.Model.FacetOptions.t), default: nil) -
pageSize (type: integer(), default: nil) - 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.
query (type: String.t, default: nil) - The raw query string. See supported search operators in the Cloud search Cheat Sheet
queryInterpretationOptions (type: GoogleApi.CloudSearch.V1.Model.QueryInterpretationOptions.t, default: nil) - Options to interpret the user query.
requestOptions (type: GoogleApi.CloudSearch.V1.Model.RequestOptions.t, default: nil) - Request options, such as the search application and user timezone.
sortOptions (type: GoogleApi.CloudSearch.V1.Model.SortOptions.t, default: nil) - The options for sorting the search results
start (type: integer(), default: nil) - Starting index of the results.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

Specs

t() :: %GoogleApi.CloudSearch.V1.Model.SearchRequest{
  contextAttributes:
    [GoogleApi.CloudSearch.V1.Model.ContextAttribute.t()] | nil,
  dataSourceRestrictions:
    [GoogleApi.CloudSearch.V1.Model.DataSourceRestriction.t()] | nil,
  facetOptions: [GoogleApi.CloudSearch.V1.Model.FacetOptions.t()] | nil,
  pageSize: integer() | nil,
  query: String.t() | nil,
  queryInterpretationOptions:
    GoogleApi.CloudSearch.V1.Model.QueryInterpretationOptions.t() | nil,
  requestOptions: GoogleApi.CloudSearch.V1.Model.RequestOptions.t() | nil,
  sortOptions: GoogleApi.CloudSearch.V1.Model.SortOptions.t() | nil,
  start: integer() | nil
}

Link to this section Functions

decode(value, options)

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.