Class Threshold (2.12.0)

Threshold(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Defines a threshold for categorizing time series values.

Attributes

NameDescription
label str
A label for the threshold.
value float
The value of the threshold. The value should be defined in the native scale of the metric.
color google.cloud.monitoring_dashboard_v1.types.Threshold.Color
The state color for this threshold. Color is not allowed in a XyChart.
direction google.cloud.monitoring_dashboard_v1.types.Threshold.Direction
The direction for the current threshold. Direction is not allowed in a XyChart.
target_axis google.cloud.monitoring_dashboard_v1.types.Threshold.TargetAxis
The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard.

Classes

Color

Color(value)

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.

Values: COLOR_UNSPECIFIED (0): Color is unspecified. Not allowed in well-formed requests. YELLOW (4): Crossing the threshold is "concerning" behavior. RED (6): Crossing the threshold is "emergency" behavior.

Direction

Direction(value)

Whether the threshold is considered crossed by an actual value above or below its threshold value.

Values: DIRECTION_UNSPECIFIED (0): Not allowed in well-formed requests. ABOVE (1): The threshold will be considered crossed if the actual value is above the threshold value. BELOW (2): The threshold will be considered crossed if the actual value is below the threshold value.

TargetAxis

TargetAxis(value)

An axis identifier.

Values: TARGET_AXIS_UNSPECIFIED (0): The target axis was not specified. Defaults to Y1. Y1 (1): The y_axis (the right axis of chart). Y2 (2): The y2_axis (the left axis of chart).