google_api_cloud_search v0.6.0 GoogleApi.CloudSearch.V1.Model.FacetBucket View Source

A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.

Attributes

  • count (type: integer(), default: nil) - Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Can be empty.
  • percentage (type: integer(), default: nil) - Percent of results that match the bucket value. This value is between (0-100]. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.
  • value (type: GoogleApi.CloudSearch.V1.Model.Value.t, default: nil) -

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.CloudSearch.V1.Model.FacetBucket{
  count: integer(),
  percentage: integer(),
  value: GoogleApi.CloudSearch.V1.Model.Value.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.