Package google.monitoring.v3

Index

Point (message)
TimeInterval (message)
TimeSeries (message)
TypedValue (message)

Point

A single data point in a time series.

Fields

Fields
`interval`	`TimeInterval` The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
`value`	`TypedValue` The value of the data point.

interval

TimeInterval

The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.

value

TypedValue

The value of the data point.

TimeInterval

A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.

Fields

Fields
`end_time`	`Timestamp` Required. The end of the time interval.
`start_time`	`Timestamp` Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

end_time

Timestamp

Required. The end of the time interval.

start_time

Timestamp

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

TimeSeries

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.

Fields
`metric`	`Metric` The associated metric. A fully-specified metric used to identify the time series.
`resource`	`MonitoredResource` 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.
`metadata`	`MonitoredResourceMetadata` 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_kind`	`MetricKind` 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`.
`value_type`	`ValueType` 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.
`points[]`	`Point` 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`.
`unit`	`string` 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. This field can only be changed through CreateTimeSeries when it is empty.
`description`	`string` Input only. A detailed description of the time series that will be associated with the `google.api.MetricDescriptor` for the metric. Once set, this field cannot be changed through CreateTimeSeries.

TypedValue

A single strongly-typed value.

Fields
Union field `value`. The typed value field. `value` can be only one of the following:
`bool_value`	`bool` A Boolean value: `true` or `false`.
`int64_value`	`int64` A 64-bit integer. Its range is approximately ±9.2x10¹⁸.
`double_value`	`double` A 64-bit double-precision floating-point number. Its magnitude is approximately ±10^±300 and it has 16 significant digits of precision.
`string_value`	`string` A variable-length string value.
`distribution_value`	`Distribution` A distribution value.