Class: Google::Apis::DataflowV1b3::MetricUpdate
- Inherits:
-
Object
- Object
- Google::Apis::DataflowV1b3::MetricUpdate
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dataflow_v1b3/classes.rb,
generated/google/apis/dataflow_v1b3/representations.rb,
generated/google/apis/dataflow_v1b3/representations.rb
Overview
Describes the state of a metric.
Instance Attribute Summary collapse
-
#cumulative ⇒ Boolean
(also: #cumulative?)
True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem.
-
#distribution ⇒ Object
A struct value describing properties of a distribution of numeric values.
-
#gauge ⇒ Object
A struct value describing properties of a Gauge.
-
#internal ⇒ Object
Worker-computed aggregate value for internal use by the Dataflow service.
-
#kind ⇒ String
Metric aggregation kind.
-
#mean_count ⇒ Object
Worker-computed aggregate value for the "Mean" aggregation kind.
-
#mean_sum ⇒ Object
Worker-computed aggregate value for the "Mean" aggregation kind.
-
#name ⇒ Google::Apis::DataflowV1b3::MetricStructuredName
Identifies a metric, by describing the source which generated the metric.
-
#scalar ⇒ Object
Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or".
-
#set ⇒ Object
Worker-computed aggregate value for the "Set" aggregation kind.
-
#update_time ⇒ String
Timestamp associated with the metric value.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MetricUpdate
constructor
A new instance of MetricUpdate.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ MetricUpdate
Returns a new instance of MetricUpdate
2491 2492 2493 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2491 def initialize(**args) update!(**args) end |
Instance Attribute Details
#cumulative ⇒ Boolean Also known as: cumulative?
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.
Corresponds to the JSON property cumulative
2418 2419 2420 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2418 def cumulative @cumulative end |
#distribution ⇒ Object
A struct value describing properties of a distribution of numeric values.
Corresponds to the JSON property distribution
2424 2425 2426 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2424 def distribution @distribution end |
#gauge ⇒ Object
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.
Corresponds to the JSON property gauge
2431 2432 2433 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2431 def gauge @gauge end |
#internal ⇒ Object
Worker-computed aggregate value for internal use by the Dataflow
service.
Corresponds to the JSON property internal
2437 2438 2439 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2437 def internal @internal end |
#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.
Corresponds to the JSON property kind
2446 2447 2448 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2446 def kind @kind end |
#mean_count ⇒ Object
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.
Corresponds to the JSON property meanCount
2454 2455 2456 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2454 def mean_count @mean_count end |
#mean_sum ⇒ Object
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.
Corresponds to the JSON property meanSum
2462 2463 2464 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2462 def mean_sum @mean_sum end |
#name ⇒ Google::Apis::DataflowV1b3::MetricStructuredName
Identifies a metric, by describing the source which generated the
metric.
Corresponds to the JSON property name
2468 2469 2470 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2468 def name @name end |
#scalar ⇒ Object
Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min",
"And", and "Or". The possible value types are Long, Double, and Boolean.
Corresponds to the JSON property scalar
2474 2475 2476 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2474 def scalar @scalar end |
#set ⇒ Object
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.
Corresponds to the JSON property set
2482 2483 2484 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2482 def set @set end |
#update_time ⇒ String
Timestamp associated with the metric value. Optional when workers are
reporting work progress; it will be filled in responses from the
metrics API.
Corresponds to the JSON property updateTime
2489 2490 2491 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2489 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2496 def update!(**args) @cumulative = args[:cumulative] if args.key?(:cumulative) @distribution = args[:distribution] if args.key?(:distribution) @gauge = args[:gauge] if args.key?(:gauge) @internal = args[:internal] if args.key?(:internal) @kind = args[:kind] if args.key?(:kind) @mean_count = args[:mean_count] if args.key?(:mean_count) @mean_sum = args[:mean_sum] if args.key?(:mean_sum) @name = args[:name] if args.key?(:name) @scalar = args[:scalar] if args.key?(:scalar) @set = args[:set] if args.key?(:set) @update_time = args[:update_time] if args.key?(:update_time) end |