GoogleApi.Monitoring.V3.Model.TimeSeries (google_api_monitoring v0.46.3) View Source

A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.

Attributes

  • metadata (type: GoogleApi.Monitoring.V3.Model.MonitoredResourceMetadata.t, default: nil) - Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
  • metric (type: GoogleApi.Monitoring.V3.Model.Metric.t, default: nil) - The associated metric. A fully-specified metric used to identify the time series.
  • metricKind (type: String.t, default: nil) - The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.
  • points (type: list(GoogleApi.Monitoring.V3.Model.Point.t), default: nil) - The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
  • resource (type: GoogleApi.Monitoring.V3.Model.MonitoredResource.t, default: nil) - The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics (https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
  • unit (type: String.t, default: nil) - The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.
  • valueType (type: String.t, default: nil) - The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Monitoring.V3.Model.TimeSeries{
  metadata: GoogleApi.Monitoring.V3.Model.MonitoredResourceMetadata.t() | nil,
  metric: GoogleApi.Monitoring.V3.Model.Metric.t() | nil,
  metricKind: String.t() | nil,
  points: [GoogleApi.Monitoring.V3.Model.Point.t()] | nil,
  resource: GoogleApi.Monitoring.V3.Model.MonitoredResource.t() | nil,
  unit: String.t() | nil,
  valueType: String.t() | nil
}

Link to this section Functions

Specs

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

Unwrap a decoded JSON object into its complex fields.