class TimeSeries extends Message

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.

Protobuf type Google\Monitoring\V3\TimeSeries

Methods

__construct()

No description

getMetric()

The associated metric. A fully-specified metric used to identify the time series.

setMetric(Metric $var)

The associated metric. A fully-specified metric used to identify the time series.

getResource()

The associated resource. A fully-specified monitored resource used to identify the time series.

setResource(MonitoredResource $var)

The associated resource. A fully-specified monitored resource used to identify the time series.

int
getMetricKind()

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.

setMetricKind(int $var)

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.

int
getValueType()

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.

setValueType(int $var)

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.

RepeatedField
getPoints()

The data points of this time series. When listing time series, the order of the points is specified by the list method.

setPoints(array|RepeatedField $var)

The data points of this time series. When listing time series, the order of the points is specified by the list method.

Details

at line 71
__construct()

at line 83
Metric getMetric()

The associated metric. A fully-specified metric used to identify the time series.

Generated from protobuf field .google.api.Metric metric = 1;

Return Value

Metric

at line 95
setMetric(Metric $var)

The associated metric. A fully-specified metric used to identify the time series.

Generated from protobuf field .google.api.Metric metric = 1;

Parameters

Metric $var

at line 108
MonitoredResource getResource()

The associated resource. A fully-specified monitored resource used to identify the time series.

Generated from protobuf field .google.api.MonitoredResource resource = 2;

Return Value

MonitoredResource

at line 120
setResource(MonitoredResource $var)

The associated resource. A fully-specified monitored resource used to identify the time series.

Generated from protobuf field .google.api.MonitoredResource resource = 2;

Parameters

MonitoredResource $var

at line 139
int getMetricKind()

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.

Generated from protobuf field .google.api.MetricDescriptor.MetricKind metric_kind = 3;

Return Value

int

at line 157
setMetricKind(int $var)

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.

Generated from protobuf field .google.api.MetricDescriptor.MetricKind metric_kind = 3;

Parameters

int $var

at line 173
int getValueType()

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.

Generated from protobuf field .google.api.MetricDescriptor.ValueType value_type = 4;

Return Value

int

at line 188
setValueType(int $var)

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.

Generated from protobuf field .google.api.MetricDescriptor.ValueType value_type = 4;

Parameters

int $var

at line 206
RepeatedField getPoints()

The data points of this time series. When listing time series, the order of the points is specified by the list method.

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.

Generated from protobuf field repeated .google.monitoring.v3.Point points = 5;

Return Value

RepeatedField

at line 223
setPoints(array|RepeatedField $var)

The data points of this time series. When listing time series, the order of the points is specified by the list method.

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.

Generated from protobuf field repeated .google.monitoring.v3.Point points = 5;

Parameters

array|RepeatedField $var