GoogleApi.CloudSearch.V1.Model.FacetBucket (google_api_cloud_search v0.9.0) 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. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. 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

Specs

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

Link to this section Functions

Specs

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

Unwrap a decoded JSON object into its complex fields.