Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::MetricUpdate (v0.9.0)

Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::MetricUpdate.

Describes the state of a metric.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cumulative

def cumulative() -> ::Boolean
Returns
  • (::Boolean) — 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.

#cumulative=

def cumulative=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#distribution

def distribution() -> ::Google::Protobuf::Value
Returns

#distribution=

def distribution=(value) -> ::Google::Protobuf::Value
Parameter
Returns

#gauge

def gauge() -> ::Google::Protobuf::Value
Returns
  • (::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.

#gauge=

def gauge=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::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.
Returns
  • (::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

def internal() -> ::Google::Protobuf::Value
Returns

#internal=

def internal=(value) -> ::Google::Protobuf::Value
Parameter
Returns

#kind

def kind() -> ::String
Returns
  • (::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.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#mean_count

def mean_count() -> ::Google::Protobuf::Value
Returns
  • (::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.

#mean_count=

def mean_count=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::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.
Returns
  • (::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.

#mean_sum

def mean_sum() -> ::Google::Protobuf::Value
Returns
  • (::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_sum=

def mean_sum=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::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.
Returns
  • (::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.

#name

def name() -> ::Google::Cloud::Dataflow::V1beta3::MetricStructuredName
Returns

#name=

def name=(value) -> ::Google::Cloud::Dataflow::V1beta3::MetricStructuredName
Parameter
Returns

#scalar

def scalar() -> ::Google::Protobuf::Value
Returns
  • (::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.

#scalar=

def scalar=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::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.
Returns
  • (::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.

#set

def set() -> ::Google::Protobuf::Value
Returns
  • (::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.

#set=

def set=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::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.
Returns
  • (::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::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.

#update_time=

def update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::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.
Returns
  • (::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.