Stackdriver Monitoring V3 Client - Class TimeSeries (1.4.0)

Version 1.4.0

• 1.12.1 (latest)
• 1.12.0
• 1.11.1
• 1.10.3
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.1
• 1.4.0
• 1.3.2
• 1.2.2

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class 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.

Generated from protobuf message google.monitoring.v3.TimeSeries

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ metric	Google\Api\Metric The associated metric. A fully-specified metric used to identify the time series.
↳ resource	Google\Api\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	Google\Api\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	int 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	int 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	array<Google\Cloud\Monitoring\V3\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.

getMetric

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

Returns
Type	Description
Google\Api\Metric|null

hasMetric

clearMetric

setMetric

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

Parameter
Name	Description
var	Google\Api\Metric

Returns
Type	Description
$this

getResource

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.

Returns
Type	Description
Google\Api\MonitoredResource|null

hasResource

clearResource

setResource

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.

Parameter
Name	Description
var	Google\Api\MonitoredResource

Returns
Type	Description
$this

getMetadata

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.

Returns
Type	Description
Google\Api\MonitoredResourceMetadata|null

hasMetadata

clearMetadata

setMetadata

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.

Parameter
Name	Description
var	Google\Api\MonitoredResourceMetadata

Returns
Type	Description
$this

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.

Returns
Type	Description
int

setMetricKind

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

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.

Returns
Type	Description
int

setValueType

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPoints

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPoints

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.

Parameter
Name	Description
var	array<Google\Cloud\Monitoring\V3\Point>

Returns
Type	Description
$this

getUnit

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.

Returns
Type	Description
string

setUnit

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this