Class: Google::Apis::SpannerV1::Metric

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

Overview

A message representing the actual monitoring data, values for each key bucket over time, of a metric.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Metric

Returns a new instance of Metric.



2308
2309
2310
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2308

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregation ⇒ String

The aggregation function used to aggregate each key bucket Corresponds to the JSON property aggregation

Returns:

  • (String) 


2239
2240
2241
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2239

def aggregation
  @aggregation
end

#category ⇒ Google::Apis::SpannerV1::LocalizedString

A message representing a user-facing string whose value may need to be translated before being displayed. Corresponds to the JSON property category

Returns:



2245
2246
2247
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2245

def category
  @category
end

#derived ⇒ Google::Apis::SpannerV1::DerivedMetric

A message representing a derived metric. Corresponds to the JSON property derived

Returns:



2250
2251
2252
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2250

def derived
  @derived
end

#display_label ⇒ Google::Apis::SpannerV1::LocalizedString

A message representing a user-facing string whose value may need to be translated before being displayed. Corresponds to the JSON property displayLabel

Returns:



2256
2257
2258
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2256

def display_label
  @display_label
end

#has_nonzero_data ⇒ Boolean Also known as: has_nonzero_data?

Whether the metric has any non-zero data. Corresponds to the JSON property hasNonzeroData

Returns:

  • (Boolean) 


2261
2262
2263
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2261

def has_nonzero_data
  @has_nonzero_data
end

#hot_value ⇒ Float

The value that is considered hot for the metric. On a per metric basis hotness signals high utilization and something that might potentially be a cause for concern by the end user. hot_value is used to calibrate and scale visual color scales. Corresponds to the JSON property hotValue

Returns:

  • (Float) 


2270
2271
2272
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2270

def hot_value
  @hot_value
end

#indexed_hot_keys ⇒ Hash<String,Google::Apis::SpannerV1::IndexedHotKey>

The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys. Corresponds to the JSON property indexedHotKeys

Returns:



2276
2277
2278
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2276

def indexed_hot_keys
  @indexed_hot_keys
end

#indexed_key_range_infos ⇒ Hash<String,Google::Apis::SpannerV1::IndexedKeyRangeInfos>

The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges. Corresponds to the JSON property indexedKeyRangeInfos

Returns:



2283
2284
2285
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2283

def indexed_key_range_infos
  @indexed_key_range_infos
end

#info ⇒ Google::Apis::SpannerV1::LocalizedString

A message representing a user-facing string whose value may need to be translated before being displayed. Corresponds to the JSON property info

Returns:



2289
2290
2291
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2289

def info
  @info
end

#matrix ⇒ Google::Apis::SpannerV1::MetricMatrix

A message representing a matrix of floats. Corresponds to the JSON property matrix

Returns:



2294
2295
2296
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2294

def matrix
  @matrix
end

#unit ⇒ Google::Apis::SpannerV1::LocalizedString

A message representing a user-facing string whose value may need to be translated before being displayed. Corresponds to the JSON property unit

Returns:



2300
2301
2302
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2300

def unit
  @unit
end

#visible ⇒ Boolean Also known as: visible?

Whether the metric is visible to the end user. Corresponds to the JSON property visible

Returns:

  • (Boolean) 


2305
2306
2307
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2305

def visible
  @visible
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2313

def update!(**args)
  @aggregation = args[:aggregation] if args.key?(:aggregation)
  @category = args[:category] if args.key?(:category)
  @derived = args[:derived] if args.key?(:derived)
  @display_label = args[:display_label] if args.key?(:display_label)
  @has_nonzero_data = args[:has_nonzero_data] if args.key?(:has_nonzero_data)
  @hot_value = args[:hot_value] if args.key?(:hot_value)
  @indexed_hot_keys = args[:indexed_hot_keys] if args.key?(:indexed_hot_keys)
  @indexed_key_range_infos = args[:indexed_key_range_infos] if args.key?(:indexed_key_range_infos)
  @info = args[:info] if args.key?(:info)
  @matrix = args[:matrix] if args.key?(:matrix)
  @unit = args[:unit] if args.key?(:unit)
  @visible = args[:visible] if args.key?(:visible)
end