Stackdriver Monitoring V3 Client - Class ValueDescriptor (2.2.0)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ValueDescriptor.

A descriptor for the value columns in a data point.

Generated from protobuf message google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor

Namespace

Google \ Cloud \ Monitoring \ V3 \ TimeSeriesDescriptor

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ key string

The value key.

↳ value_type int

The value type.

↳ metric_kind int

The value stream kind.

↳ unit string

The unit in which time_series point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. unit is only valid if value_type is INTEGER, DOUBLE, DISTRIBUTION.

getKey

The value key.

Returns
Type Description
string

setKey

The value key.

Parameter
Name Description
var string
Returns
Type Description
$this

getValueType

The value type.

Returns
Type Description
int Enum of type ValueType.

setValueType

The value type.

Parameter
Name Description
var int

Enum of type ValueType.

Returns
Type Description
$this

getMetricKind

The value stream kind.

Returns
Type Description
int Enum of type MetricKind.

setMetricKind

The value stream kind.

Parameter
Name Description
var int

Enum of type MetricKind.

Returns
Type Description
$this

getUnit

The unit in which time_series point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html.

unit is only valid if value_type is INTEGER, DOUBLE, DISTRIBUTION.

Returns
Type Description
string

setUnit

The unit in which time_series point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html.

unit is only valid if value_type is INTEGER, DOUBLE, DISTRIBUTION.

Parameter
Name Description
var string
Returns
Type Description
$this