Class: Google::Apis::MonitoringV1::Threshold

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

Overview

Defines a threshold for categorizing time series values.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Threshold

Returns a new instance of Threshold.



2321
2322
2323
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2321

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

Instance Attribute Details

#color ⇒ String

The state color for this threshold. Color is not allowed in a XyChart. Corresponds to the JSON property color

Returns:

  • (String) 


2297
2298
2299
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2297

def color
  @color
end

#direction ⇒ String

The direction for the current threshold. Direction is not allowed in a XyChart. Corresponds to the JSON property direction

Returns:

  • (String) 


2302
2303
2304
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2302

def direction
  @direction
end

#label ⇒ String

A label for the threshold. Corresponds to the JSON property label

Returns:

  • (String) 


2307
2308
2309
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2307

def label
  @label
end

#target_axis ⇒ String

The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. Corresponds to the JSON property targetAxis

Returns:

  • (String) 


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

def target_axis
  @target_axis
end

#value ⇒ Float

The value of the threshold. The value should be defined in the native scale of the metric. Corresponds to the JSON property value

Returns:

  • (Float) 


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

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2326
2327
2328
2329
2330
2331
2332
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2326

def update!(**args)
  @color = args[:color] if args.key?(:color)
  @direction = args[:direction] if args.key?(:direction)
  @label = args[:label] if args.key?(:label)
  @target_axis = args[:target_axis] if args.key?(:target_axis)
  @value = args[:value] if args.key?(:value)
end