AlertPolicyConditionConditionThreshold class
Constructors
-
AlertPolicyConditionConditionThreshold({Input<List<AlertPolicyConditionConditionThresholdAggregation>?>? aggregations, required Input<String> comparison, Input<List<AlertPolicyConditionConditionThresholdDenominatorAggregation>?>? denominatorAggregations, Input<String?>? denominatorFilter, required Input<String> duration, Input<String?>? evaluationMissingData, Input<String?>? filter, Input<AlertPolicyConditionConditionThresholdForecastOptions?>? forecastOptions, Input<double?>? thresholdValue, Input<AlertPolicyConditionConditionThresholdTrigger?>? trigger})
-
Creates a new AlertPolicyConditionConditionThreshold.
aggregations Specifies the alignment of data points in
comparison The comparison to apply between the time series
denominatorAggregations Specifies the alignment of data points in
denominatorFilter A filter that identifies a time series that
duration The amount of time that a time series must
evaluationMissingData A condition control that determines how
filter A filter that identifies which time series
forecastOptions When this field is present, the MetricThreshold
thresholdValue A value against which to compare the time
trigger The number/percent of time series for which
const
-
AlertPolicyConditionConditionThreshold.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
aggregations
→ Input<List<AlertPolicyConditionConditionThresholdAggregation>?>?
-
Specifies the alignment of data points in
individual time series as well as how to
combine the retrieved time series together
(such as when aggregating multiple streams
on each resource to a single stream for each
resource or when aggregating streams across
all members of a group of resources).
Multiple aggregations are applied in the
order specified.This field is similar to the
one in the MetricService.ListTimeSeries
request. It is advisable to use the
ListTimeSeries method when debugging this
field.
Structure is documented below.
final
-
comparison
→ Input<String>
-
The comparison to apply between the time series
(indicated by filter and aggregation) and the threshold
(indicated by threshold_value). The comparison is
applied on each time series, with the time series on
the left-hand side and the threshold on the right-hand
side.
The Cloud Monitoring API only supports
COMPARISON_LT
and COMPARISON_GT for metric-threshold conditions; the
other values are kept in the schema for backward
compatibility with imported state but will be rejected
by the API. See
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies#MetricThreshold.
Possible values are: COMPARISON_GT, COMPARISON_GE, COMPARISON_LT, COMPARISON_LE, COMPARISON_EQ, COMPARISON_NE.
final
-
denominatorAggregations
→ Input<List<AlertPolicyConditionConditionThresholdDenominatorAggregation>?>?
-
Specifies the alignment of data points in
individual time series selected by
denominatorFilter as well as how to combine
the retrieved time series together (such as
when aggregating multiple streams on each
resource to a single stream for each
resource or when aggregating streams across
all members of a group of resources).When
computing ratios, the aggregations and
denominatorAggregations fields must use the
same alignment period and produce time
series that have the same periodicity and
labels.This field is similar to the one in
the MetricService.ListTimeSeries request. It
is advisable to use the ListTimeSeries
method when debugging this field.
Structure is documented below.
final
-
denominatorFilter
→ Input<String?>?
-
A filter that identifies a time series that
should be used as the denominator of a ratio
that will be compared with the threshold. If
a denominatorFilter is specified, the time
series specified by the filter field will be
used as the numerator.The filter is similar
to the one that is specified in the
MetricService.ListTimeSeries request (that
call is useful to verify the time series
that will be retrieved / processed) and must
specify the metric type and optionally may
contain restrictions on resource type,
resource labels, and metric labels. This
field may not exceed 2048 Unicode characters
in length.
final
-
duration
→ Input<String>
-
The amount of time that a time series must
violate the threshold to be considered
failing. Currently, only values that are a
multiple of a minute--e.g., 0, 60, 120, or
300 seconds--are supported. If an invalid
value is given, an error will be returned.
When choosing a duration, it is useful to
keep in mind the frequency of the underlying
time series data (which may also be affected
by any alignments specified in the
aggregations field); a good duration is long
enough so that a single outlier does not
generate spurious alerts, but short enough
that unhealthy states are detected and
alerted on quickly.
final
-
evaluationMissingData
→ Input<String?>?
-
A condition control that determines how
metric-threshold conditions are evaluated when
data stops arriving.
Possible values are:
EVALUATION_MISSING_DATA_INACTIVE, EVALUATION_MISSING_DATA_ACTIVE, EVALUATION_MISSING_DATA_NO_OP.
final
-
filter
→ Input<String?>?
-
A filter that identifies which time series
should be compared with the threshold.The
filter is similar to the one that is
specified in the
MetricService.ListTimeSeries request (that
call is useful to verify the time series
that will be retrieved / processed) and must
specify the metric type and optionally may
contain restrictions on resource type,
resource labels, and metric labels. This
field may not exceed 2048 Unicode characters
in length.
final
-
forecastOptions
→ Input<AlertPolicyConditionConditionThresholdForecastOptions?>?
-
When this field is present, the
MetricThreshold
condition forecasts whether the time series is
predicted to violate the threshold within the
forecastHorizon. When this field is not set, the
MetricThreshold tests the current value of the
timeseries against the threshold.
Structure is documented below.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
thresholdValue
→ Input<double?>?
-
A value against which to compare the time
series.
final
-
trigger
→ Input<AlertPolicyConditionConditionThresholdTrigger?>?
-
The number/percent of time series for which
the comparison must hold in order for the
condition to trigger. If unspecified, then
the condition will trigger if the comparison
is true for any of the time series that have
been identified by filter and aggregations,
or by the ratio, if denominatorFilter and
denominatorAggregations are specified.
Structure is documented below.
final
