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.



2338
2339
2340
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2338

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) 


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

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:



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

def category
  @category
end

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

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

Returns:



2280
2281
2282
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2280

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:



2286
2287
2288
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2286

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) 


2291
2292
2293
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2291

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) 


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

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:



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

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:



2313
2314
2315
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2313

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:



2319
2320
2321
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2319

def info
  @info
end

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

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

Returns:



2324
2325
2326
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2324

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:



2330
2331
2332
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2330

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) 


2335
2336
2337
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2335

def visible
  @visible
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2343

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