Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class MetricUpdate.
Describes the state of a metric.
Generated from protobuf message google.dataflow.v1beta3.MetricUpdate
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
↳ kind
string
Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
↳ cumulative
bool
True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
↳ scalar
Google\Protobuf\Value
Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.
↳ mean_sum
Google\Protobuf\Value
Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.
↳ mean_count
Google\Protobuf\Value
Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.
↳ set
Google\Protobuf\Value
Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.
↳ distribution
↳ gauge
Google\Protobuf\Value
A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
↳ internal
↳ update_time
Google\Protobuf\Timestamp
Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
getName
Name of the metric.
hasName
clearName
setName
Name of the metric.
$this
getKind
Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution".
The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
string
setKind
Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution".
The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
var
string
$this
getCumulative
True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem.
By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
bool
setCumulative
True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem.
By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
var
bool
$this
getScalar
Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.
hasScalar
clearScalar
setScalar
Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.
$this
getMeanSum
Worker-computed aggregate value for the "Mean" aggregation kind.
This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.
hasMeanSum
clearMeanSum
setMeanSum
Worker-computed aggregate value for the "Mean" aggregation kind.
This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.
$this
getMeanCount
Worker-computed aggregate value for the "Mean" aggregation kind.
This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.
hasMeanCount
clearMeanCount
setMeanCount
Worker-computed aggregate value for the "Mean" aggregation kind.
This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.
$this
getSet
Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.
hasSet
clearSet
setSet
Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.
$this
getDistribution
A struct value describing properties of a distribution of numeric values.
hasDistribution
clearDistribution
setDistribution
A struct value describing properties of a distribution of numeric values.
$this
getGauge
A struct value describing properties of a Gauge.
Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
hasGauge
clearGauge
setGauge
A struct value describing properties of a Gauge.
Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
$this
getInternal
Worker-computed aggregate value for internal use by the Dataflow service.
hasInternal
clearInternal
setInternal
Worker-computed aggregate value for internal use by the Dataflow service.
$this
getUpdateTime
Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
hasUpdateTime
clearUpdateTime
setUpdateTime
Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
$this
