GoogleApi.Spanner.V1.Model.Metric (google_api_spanner v0.48.0)

View Source

A message representing the actual monitoring data, values for each key bucket over time, of a metric.

Attributes

  • aggregation (type: String.t, default: nil) - The aggregation function used to aggregate each key bucket
  • category (type: GoogleApi.Spanner.V1.Model.LocalizedString.t, default: nil) - The category of the metric, e.g. "Activity", "Alerts", "Reads", etc.
  • derived (type: GoogleApi.Spanner.V1.Model.DerivedMetric.t, default: nil) - The references to numerator and denominator metrics for a derived metric.
  • displayLabel (type: GoogleApi.Spanner.V1.Model.LocalizedString.t, default: nil) - The displayed label of the metric.
  • hasNonzeroData (type: boolean(), default: nil) - Whether the metric has any non-zero data.
  • hotValue (type: number(), default: nil) - The value that is considered hot for the metric. On a per metric basis hotness signals high utilization and something that might potentially be a cause for concern by the end user. hot_value is used to calibrate and scale visual color scales.
  • indexedHotKeys (type: %{optional(String.t) => GoogleApi.Spanner.V1.Model.IndexedHotKey.t}, default: nil) - The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys.
  • indexedKeyRangeInfos (type: %{optional(String.t) => GoogleApi.Spanner.V1.Model.IndexedKeyRangeInfos.t}, default: nil) - The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges.
  • info (type: GoogleApi.Spanner.V1.Model.LocalizedString.t, default: nil) - Information about the metric.
  • matrix (type: GoogleApi.Spanner.V1.Model.MetricMatrix.t, default: nil) - The data for the metric as a matrix.
  • unit (type: GoogleApi.Spanner.V1.Model.LocalizedString.t, default: nil) - The unit of the metric.
  • visible (type: boolean(), default: nil) - Whether the metric is visible to the end user.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Spanner.V1.Model.Metric{
  aggregation: String.t() | nil,
  category: GoogleApi.Spanner.V1.Model.LocalizedString.t() | nil,
  derived: GoogleApi.Spanner.V1.Model.DerivedMetric.t() | nil,
  displayLabel: GoogleApi.Spanner.V1.Model.LocalizedString.t() | nil,
  hasNonzeroData: boolean() | nil,
  hotValue: number() | nil,
  indexedHotKeys:
    %{optional(String.t()) => GoogleApi.Spanner.V1.Model.IndexedHotKey.t()}
    | nil,
  indexedKeyRangeInfos:
    %{
      optional(String.t()) =>
        GoogleApi.Spanner.V1.Model.IndexedKeyRangeInfos.t()
    }
    | nil,
  info: GoogleApi.Spanner.V1.Model.LocalizedString.t() | nil,
  matrix: GoogleApi.Spanner.V1.Model.MetricMatrix.t() | nil,
  unit: GoogleApi.Spanner.V1.Model.LocalizedString.t() | nil,
  visible: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.