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



2217
2218
2219
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2217

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) 


2151
2152
2153
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2151

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) 


2157
2158
2159
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2157

def distribution
  @distribution
end

#internal ⇒ Object

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

Returns:

  • (Object) 


2163
2164
2165
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2163

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) 


2172
2173
2174
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2172

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) 


2180
2181
2182
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2180

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) 


2188
2189
2190
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2188

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:



2194
2195
2196
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2194

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) 


2200
2201
2202
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2200

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) 


2208
2209
2210
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2208

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) 


2215
2216
2217
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2215

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2222

def update!(**args)
  @cumulative = args[:cumulative] if args.key?(:cumulative)
  @distribution = args[:distribution] if args.key?(:distribution)
  @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