TimeSeries

The metrics object for a SubTask.

JSON representation
{"metric":string,"valueType":enum (ValueType),"metricKind":enum (MetricKind),"points":[{object (Point)}]}
Fields
metric

string

Required. The name of the metric.

If the metric is not known by the service yet, it will be auto-created.

valueType

enum (ValueType)

Required. The value type of the time series.

metricKind

enum (MetricKind)

Optional. The metric kind of the time series.

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 eitherGAUGE (the default) orCUMULATIVE.

points[]

object (Point)

Required. 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 beBOOL,INT64,DOUBLE, orDISTRIBUTION.

Point

A single data point in a time series.

JSON representation
{"interval":{object (TimeInterval)},"value":{object (TypedValue)}}
Fields
interval

object (TimeInterval)

The time interval to which the data point applies. ForGAUGE metrics, the start time does not need to be supplied, but if it is supplied, it must equal the end time. ForDELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. ForCUMULATIVE 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

object (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.

JSON representation
{"startTime":string,"endTime":string}
Fields
startTime

string (Timestamp format)

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.

endTime

string (Timestamp format)

Required. The end of the time interval.

TypedValue

A single strongly-typed value.

JSON representation
{// Union fieldvalue can be only one of the following:"boolValue":boolean,"int64Value":string,"doubleValue":number,"stringValue":string,"distributionValue":{object (Distribution)}// End of list of possible types for union fieldvalue.}
Fields
Union fieldvalue. The typed value field.value can be only one of the following:
boolValue

boolean

A Boolean value:true orfalse.

int64Value

string (int64 format)

A 64-bit integer. Its range is approximately+/-9.2x10^18.

doubleValue

number

A 64-bit double-precision floating-point number. Its magnitude is approximately+/-10^(+/-300) and it has 16 significant digits of precision.

stringValue

string

A variable-length string value.

distributionValue

object (Distribution)

A distribution value.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-02 UTC.