View Source GoogleApi.Pollen.V1.Model.IndexInfo (google_api_pollen v0.3.0)

This object contains data representing specific pollen index value, category and description.

Attributes

  • category (type: String.t, default: nil) - Text classification of index numerical score interpretation. The index consists of six categories: 0: "None" 1: "Very low" 2: "Low" 3: "Moderate" 4: "High" 5: "Very high
  • code (type: String.t, default: nil) - The index's code. This field represents the index for programming purposes by using snake cases instead of spaces. Example: "UPI".
  • color (type: GoogleApi.Pollen.V1.Model.Color.t, default: nil) - The color used to represent the Pollen Index numeric score.
  • displayName (type: String.t, default: nil) - A human readable representation of the index name. Example: "Universal Pollen Index".
  • indexDescription (type: String.t, default: nil) - Textual explanation of current index level.
  • value (type: integer(), default: nil) - The index's numeric score. Numeric range is between 0 and 5.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Pollen.V1.Model.IndexInfo{
  category: String.t() | nil,
  code: String.t() | nil,
  color: GoogleApi.Pollen.V1.Model.Color.t() | nil,
  displayName: String.t() | nil,
  indexDescription: String.t() | nil,
  value: integer() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.