Class: Google::Cloud::Monitoring::Dashboard::V1::Threshold

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/dashboard/v1/metrics.rb

Overview

Defines a threshold for categorizing time series values.

Defined Under Namespace

Modules: Color, Direction, TargetAxis

Instance Attribute Summary collapse

Instance Attribute Details

#color ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Threshold::Color

Returns The state color for this threshold. Color is not allowed in a XyChart.

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/monitoring/dashboard/v1/metrics.rb', line 151

class Threshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The color suggests an interpretation to the viewer when actual values cross
  # the threshold. Comments on each color provide UX guidance on how users can
  # be expected to interpret a given state color.
  module Color
    # Color is unspecified. Not allowed in well-formed requests.
    COLOR_UNSPECIFIED = 0

    # Crossing the threshold is "concerning" behavior.
    YELLOW = 4

    # Crossing the threshold is "emergency" behavior.
    RED = 6
  end

  # Whether the threshold is considered crossed by an actual value above or
  # below its threshold value.
  module Direction
    # Not allowed in well-formed requests.
    DIRECTION_UNSPECIFIED = 0

    # The threshold will be considered crossed if the actual value is above
    # the threshold value.
    ABOVE = 1

    # The threshold will be considered crossed if the actual value is below
    # the threshold value.
    BELOW = 2
  end

  # An axis identifier.
  module TargetAxis
    # The target axis was not specified. Defaults to Y1.
    TARGET_AXIS_UNSPECIFIED = 0

    # The y_axis (the right axis of chart).
    Y1 = 1

    # The y2_axis (the left axis of chart).
    Y2 = 2
  end
end

#direction ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Threshold::Direction

Returns The direction for the current threshold. Direction is not allowed in a XyChart.

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/monitoring/dashboard/v1/metrics.rb', line 151

class Threshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The color suggests an interpretation to the viewer when actual values cross
  # the threshold. Comments on each color provide UX guidance on how users can
  # be expected to interpret a given state color.
  module Color
    # Color is unspecified. Not allowed in well-formed requests.
    COLOR_UNSPECIFIED = 0

    # Crossing the threshold is "concerning" behavior.
    YELLOW = 4

    # Crossing the threshold is "emergency" behavior.
    RED = 6
  end

  # Whether the threshold is considered crossed by an actual value above or
  # below its threshold value.
  module Direction
    # Not allowed in well-formed requests.
    DIRECTION_UNSPECIFIED = 0

    # The threshold will be considered crossed if the actual value is above
    # the threshold value.
    ABOVE = 1

    # The threshold will be considered crossed if the actual value is below
    # the threshold value.
    BELOW = 2
  end

  # An axis identifier.
  module TargetAxis
    # The target axis was not specified. Defaults to Y1.
    TARGET_AXIS_UNSPECIFIED = 0

    # The y_axis (the right axis of chart).
    Y1 = 1

    # The y2_axis (the left axis of chart).
    Y2 = 2
  end
end

#label ⇒ ::String

Returns A label for the threshold.

Returns:

  • (::String) —

    A label for the threshold.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/monitoring/dashboard/v1/metrics.rb', line 151

class Threshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The color suggests an interpretation to the viewer when actual values cross
  # the threshold. Comments on each color provide UX guidance on how users can
  # be expected to interpret a given state color.
  module Color
    # Color is unspecified. Not allowed in well-formed requests.
    COLOR_UNSPECIFIED = 0

    # Crossing the threshold is "concerning" behavior.
    YELLOW = 4

    # Crossing the threshold is "emergency" behavior.
    RED = 6
  end

  # Whether the threshold is considered crossed by an actual value above or
  # below its threshold value.
  module Direction
    # Not allowed in well-formed requests.
    DIRECTION_UNSPECIFIED = 0

    # The threshold will be considered crossed if the actual value is above
    # the threshold value.
    ABOVE = 1

    # The threshold will be considered crossed if the actual value is below
    # the threshold value.
    BELOW = 2
  end

  # An axis identifier.
  module TargetAxis
    # The target axis was not specified. Defaults to Y1.
    TARGET_AXIS_UNSPECIFIED = 0

    # The y_axis (the right axis of chart).
    Y1 = 1

    # The y2_axis (the left axis of chart).
    Y2 = 2
  end
end

#target_axis ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Threshold::TargetAxis

Returns The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard.

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/monitoring/dashboard/v1/metrics.rb', line 151

class Threshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The color suggests an interpretation to the viewer when actual values cross
  # the threshold. Comments on each color provide UX guidance on how users can
  # be expected to interpret a given state color.
  module Color
    # Color is unspecified. Not allowed in well-formed requests.
    COLOR_UNSPECIFIED = 0

    # Crossing the threshold is "concerning" behavior.
    YELLOW = 4

    # Crossing the threshold is "emergency" behavior.
    RED = 6
  end

  # Whether the threshold is considered crossed by an actual value above or
  # below its threshold value.
  module Direction
    # Not allowed in well-formed requests.
    DIRECTION_UNSPECIFIED = 0

    # The threshold will be considered crossed if the actual value is above
    # the threshold value.
    ABOVE = 1

    # The threshold will be considered crossed if the actual value is below
    # the threshold value.
    BELOW = 2
  end

  # An axis identifier.
  module TargetAxis
    # The target axis was not specified. Defaults to Y1.
    TARGET_AXIS_UNSPECIFIED = 0

    # The y_axis (the right axis of chart).
    Y1 = 1

    # The y2_axis (the left axis of chart).
    Y2 = 2
  end
end

#value ⇒ ::Float

Returns The value of the threshold. The value should be defined in the native scale of the metric.

Returns:

  • (::Float) —

    The value of the threshold. The value should be defined in the native scale of the metric.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/monitoring/dashboard/v1/metrics.rb', line 151

class Threshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The color suggests an interpretation to the viewer when actual values cross
  # the threshold. Comments on each color provide UX guidance on how users can
  # be expected to interpret a given state color.
  module Color
    # Color is unspecified. Not allowed in well-formed requests.
    COLOR_UNSPECIFIED = 0

    # Crossing the threshold is "concerning" behavior.
    YELLOW = 4

    # Crossing the threshold is "emergency" behavior.
    RED = 6
  end

  # Whether the threshold is considered crossed by an actual value above or
  # below its threshold value.
  module Direction
    # Not allowed in well-formed requests.
    DIRECTION_UNSPECIFIED = 0

    # The threshold will be considered crossed if the actual value is above
    # the threshold value.
    ABOVE = 1

    # The threshold will be considered crossed if the actual value is below
    # the threshold value.
    BELOW = 2
  end

  # An axis identifier.
  module TargetAxis
    # The target axis was not specified. Defaults to Y1.
    TARGET_AXIS_UNSPECIFIED = 0

    # The y_axis (the right axis of chart).
    Y1 = 1

    # The y2_axis (the left axis of chart).
    Y2 = 2
  end
end