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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataflow_v1b3/classes.rb,
lib/google/apis/dataflow_v1b3/representations.rb,
lib/google/apis/dataflow_v1b3/representations.rb

Overview

Describes the state of a metric. Next ID: 14

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MetricUpdate

Returns a new instance of MetricUpdate.



3557
3558
3559
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3557

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) 


3483
3484
3485
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3483

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) 


3489
3490
3491
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3489

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) 


3495
3496
3497
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3495

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) 


3500
3501
3502
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3500

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) 


3508
3509
3510
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3508

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) 


3516
3517
3518
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3516

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) 


3524
3525
3526
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3524

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:



3529
3530
3531
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3529

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) 


3535
3536
3537
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3535

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, String, or BoundedTrie 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) 


3543
3544
3545
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3543

def set
  @set
end

#trie ⇒ Object

Worker-computed aggregate value for the "Trie" aggregation kind. The only possible value type is a BoundedTrieNode. Corresponds to the JSON property trie

Returns:

  • (Object) 


3549
3550
3551
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3549

def trie
  @trie
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) 


3555
3556
3557
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3555

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3562

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)
  @trie = args[:trie] if args.key?(:trie)
  @update_time = args[:update_time] if args.key?(:update_time)
end