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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MetricUpdate

Returns a new instance of MetricUpdate.



3247
3248
3249
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3247

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) 


3179
3180
3181
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3179

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) 


3185
3186
3187
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3185

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) 


3191
3192
3193
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3191

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) 


3196
3197
3198
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3196

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) 


3204
3205
3206
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3204

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) 


3212
3213
3214
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3212

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) 


3220
3221
3222
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3220

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:



3225
3226
3227
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3225

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) 


3231
3232
3233
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3231

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) 


3239
3240
3241
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3239

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) 


3245
3246
3247
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3245

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3252

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