Class: Google::Apis::DataflowV1b3::MetricUpdate

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ MetricUpdate

Returns a new instance of MetricUpdate



2530
2531
2532
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2530

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

Returns:

  • (Boolean) 


2457
2458
2459
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2457

def cumulative
  @cumulative
end

#distribution ⇒ Object

A struct value describing properties of a distribution of numeric values. Corresponds to the JSON property distribution

Returns:

  • (Object) 


2463
2464
2465
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2463

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

Returns:

  • (Object) 


2470
2471
2472
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2470

def gauge
  @gauge
end

#internal ⇒ Object

Worker-computed aggregate value for internal use by the Dataflow service. Corresponds to the JSON property internal

Returns:

  • (Object) 


2476
2477
2478
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2476

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

Returns:

  • (String) 


2485
2486
2487
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2485

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

Returns:

  • (Object) 


2493
2494
2495
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2493

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

Returns:

  • (Object) 


2501
2502
2503
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2501

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

Returns:



2507
2508
2509
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2507

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

Returns:

  • (Object) 


2513
2514
2515
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2513

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

Returns:

  • (Object) 


2521
2522
2523
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2521

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

Returns:

  • (String) 


2528
2529
2530
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2528

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2535

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