Class: Google::Cloud::Dataflow::V1beta3::MetricUpdate

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/dataflow/v1beta3/metrics.rb

Overview

Describes the state of a metric.

Instance Attribute Summary collapse

Instance Attribute Details

#cumulative ⇒ ::Boolean

Returns 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.



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#distribution ⇒ ::Google::Protobuf::Value

Returns A struct value describing properties of a distribution of numeric values.

Returns:



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#gauge ⇒ ::Google::Protobuf::Value

Returns 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.



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#internal ⇒ ::Google::Protobuf::Value

Returns Worker-computed aggregate value for internal use by the Dataflow service.

Returns:



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#kind ⇒ ::String

Returns 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.



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mean_count ⇒ ::Google::Protobuf::Value

Returns 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.



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mean_sum ⇒ ::Google::Protobuf::Value

Returns 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.



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::Google::Cloud::Dataflow::V1beta3::MetricStructuredName

Returns Name of the metric.

Returns:



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#scalar ⇒ ::Google::Protobuf::Value

Returns 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.



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#set ⇒ ::Google::Protobuf::Value

Returns 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.



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.



112
113
114
115
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 112

class MetricUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end