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



3505
3506
3507
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3505

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) 


3450
3451
3452
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3450

def cumulative
  @cumulative
end

#internal ⇒ Object

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

Returns:

  • (Object) 


3442
3443
3444
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3442

def internal
  @internal
end

#kind ⇒ String

Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", and "Or". 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) 


3460
3461
3462
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3460

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) 


3474
3475
3476
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3474

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) 


3482
3483
3484
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3482

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:



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

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) 


3466
3467
3468
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3466

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) 


3503
3504
3505
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3503

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) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3510

def update!(**args)
  @internal = args[:internal] if args.key?(:internal)
  @cumulative = args[:cumulative] if args.key?(:cumulative)
  @kind = args[:kind] if args.key?(:kind)
  @scalar = args[:scalar] if args.key?(:scalar)
  @mean_count = args[:mean_count] if args.key?(:mean_count)
  @mean_sum = args[:mean_sum] if args.key?(:mean_sum)
  @update_time = args[:update_time] if args.key?(:update_time)
  @name = args[:name] if args.key?(:name)
  @set = args[:set] if args.key?(:set)
end