Type Members

1.  final case class DistributionValue(count: Long = 0L, sum: Double = 0.0, sumOfSquaredDeviation: Double = 0.0, bucketOptions: Option[BucketOptions] = _root_.scala.None, buckets: Seq[Bucket] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DistributionValue] with Product with Serializable

   Distribution contains summary statistics for a population of values.

   Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.

   count

   The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.

   sum

   The sum of the values in the population. If count is zero then this field must be zero.

   sumOfSquaredDeviation

   The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass. If count is zero then this field must be zero.

   bucketOptions

   Don't change bucket boundaries within a TimeSeries if your backend doesn't support this. TODO(issue #152): consider not required to send bucket options for optimization.

   buckets

   If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in the Bucket counts must equal the value in the count field of the distribution.

   Annotations

   @SerialVersionUID()

2.  final case class LabelKey(key: String = "", description: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[LabelKey] with Product with Serializable

   Defines a label key associated with a metric descriptor.

   Defines a label key associated with a metric descriptor.

   key

   The key for the label.

   description

   A human-readable description of what this label key represents.

   Annotations

   @SerialVersionUID()

3.  final case class LabelValue(value: String = "", hasValue: Boolean = false, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[LabelValue] with Product with Serializable
   value

   The value for the label.

   hasValue

   If false the value field is ignored and considered not set. This is used to differentiate a missing label from an empty string.

   Annotations

   @SerialVersionUID()

4.  final case class Metric(metricDescriptor: Option[MetricDescriptor] = _root_.scala.None, timeseries: Seq[TimeSeries] = _root_.scala.Seq.empty, resource: Option[Resource] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Metric] with Product with Serializable

   Defines a Metric which has one or more timeseries.

   Defines a Metric which has one or more timeseries.

   metricDescriptor

   The descriptor of the Metric. TODO(issue #152): consider only sending the name of descriptor for optimization.

   timeseries

   One or more timeseries for a single metric, where each timeseries has one or more points.

   resource

   The resource for the metric. If unset, it may be set to a default value provided for a sequence of messages in an RPC stream.

   Annotations

   @SerialVersionUID()

5.  final case class MetricDescriptor(name: String = "", description: String = "", unit: String = "", type: Type = ..., labelKeys: Seq[LabelKey] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[MetricDescriptor] with Product with Serializable

   Defines a metric type and its schema.

   Defines a metric type and its schema.

   name

   The metric type, including its DNS name prefix. It must be unique.

   description

   A detailed description of the metric, which can be used in documentation.

   unit

   The unit in which the metric value is reported. Follows the format described by http://unitsofmeasure.org/ucum.html.

   labelKeys

   The label keys associated with the metric descriptor.

   Annotations

   @SerialVersionUID()

6.  final case class Point(timestamp: Option[Timestamp] = _root_.scala.None, value: Value = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Point] with Product with Serializable

   A timestamped measurement.

   A timestamped measurement.

   timestamp

   The moment when this point was recorded. Inclusive. If not specified, the timestamp will be decided by the backend.

   Annotations

   @SerialVersionUID()

7.  final case class SummaryValue(count: Option[Long] = _root_.scala.None, sum: Option[Double] = _root_.scala.None, snapshot: Option[Snapshot] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SummaryValue] with Product with Serializable

   The start_timestamp only applies to the count and sum in the SummaryValue.

   The start_timestamp only applies to the count and sum in the SummaryValue.

   count

   The total number of recorded values since start_time. Optional since some systems don't expose this.

   sum

   The total sum of recorded values since start_time. Optional since some systems don't expose this. If count is zero then this field must be zero. This field must be unset if the sum is not available.

   snapshot

   Values calculated over an arbitrary time window.

   Annotations

   @SerialVersionUID()

8.  final case class TimeSeries(startTimestamp: Option[Timestamp] = _root_.scala.None, labelValues: Seq[LabelValue] = _root_.scala.Seq.empty, points: Seq[Point] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[TimeSeries] with Product with Serializable

   A collection of data points that describes the time-varying values of a metric.

   A collection of data points that describes the time-varying values of a metric.

   startTimestamp

   Must be present for cumulative metrics. The time when the cumulative value was reset to zero. Exclusive. The cumulative value is over the time interval (start_timestamp, timestamp]. If not specified, the backend can use the previous recorded value.

   labelValues

   The set of label values that uniquely identify this timeseries. Applies to all points. The order of label values must match that of label keys in the metric descriptor.

   points

   The data points of this timeseries. Point.value type MUST match the MetricDescriptor.type.

   Annotations

   @SerialVersionUID()