Stackdriver Monitoring V3 Client - Class ValueDescriptor (1.5.1)

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
NameDescription
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
TypeDescription
string

setKey

The value key.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getValueType

The value type.

Returns
TypeDescription
int

setValueType

The value type.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMetricKind

The value stream kind.

Returns
TypeDescription
int

setMetricKind

The value stream kind.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this