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

The search API response.

Attributes

debugInfo (type: GoogleApi.CloudSearch.V1.Model.ResponseDebugInfo.t, default: nil) - Debugging information about the response.
errorInfo (type: GoogleApi.CloudSearch.V1.Model.ErrorInfo.t, default: nil) - Error information about the response.
facetResults (type: list(GoogleApi.CloudSearch.V1.Model.FacetResult.t), default: nil) - Repeated facet results.
hasMoreResults (type: boolean(), default: nil) - Whether there are more search results matching the query.
queryInterpretation (type: GoogleApi.CloudSearch.V1.Model.QueryInterpretation.t, default: nil) - Query interpretation result for user query. Empty if query interpretation is disabled.
resultCountEstimate (type: String.t, default: nil) - The estimated result count for this query.
resultCountExact (type: String.t, default: nil) - The exact result count for this query.
resultCounts (type: GoogleApi.CloudSearch.V1.Model.ResultCounts.t, default: nil) - Expanded result count information.
results (type: list(GoogleApi.CloudSearch.V1.Model.SearchResult.t), default: nil) - Results from a search query.
spellResults (type: list(GoogleApi.CloudSearch.V1.Model.SpellResult.t), default: nil) - Suggested spelling for the query.
structuredResults (type: list(GoogleApi.CloudSearch.V1.Model.StructuredResult.t), default: nil) - Structured results for the user query. These results are not counted against the page_size.

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.SearchResponse{
  debugInfo: GoogleApi.CloudSearch.V1.Model.ResponseDebugInfo.t() | nil,
  errorInfo: GoogleApi.CloudSearch.V1.Model.ErrorInfo.t() | nil,
  facetResults: [GoogleApi.CloudSearch.V1.Model.FacetResult.t()] | nil,
  hasMoreResults: boolean() | nil,
  queryInterpretation:
    GoogleApi.CloudSearch.V1.Model.QueryInterpretation.t() | nil,
  resultCountEstimate: String.t() | nil,
  resultCountExact: String.t() | nil,
  resultCounts: GoogleApi.CloudSearch.V1.Model.ResultCounts.t() | nil,
  results: [GoogleApi.CloudSearch.V1.Model.SearchResult.t()] | nil,
  spellResults: [GoogleApi.CloudSearch.V1.Model.SpellResult.t()] | nil,
  structuredResults: [GoogleApi.CloudSearch.V1.Model.StructuredResult.t()] | nil
}

Link to this section Functions

decode(value, options)

Specs

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

Unwrap a decoded JSON object into its complex fields.