EnterpriseCrmEventbusProtoTaskAlertConfigResponse class

Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.

Constructors

EnterpriseCrmEventbusProtoTaskAlertConfigResponse({required Input<String> aggregationPeriod, required Input<bool> alertDisabled, required Input<String> alertName, required Input<String> clientId, required Input<String> durationThresholdMs, required Input<EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumListResponse> errorEnumList, required Input<String> metricType, required Input<int> numAggregationPeriods, required Input<bool> onlyFinalAttempt, required Input<String> playbookUrl, required Input<String> thresholdType, required Input<EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValueResponse> thresholdValue, required Input<EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumListResponse> warningEnumList})
Creates a new EnterpriseCrmEventbusProtoTaskAlertConfigResponse. aggregationPeriod The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). alertDisabled Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert. alertName A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow. clientId Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers. durationThresholdMs Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger. errorEnumList Required. metricType Required. numAggregationPeriods For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired. onlyFinalAttempt Only count final task attempts, not retries. playbookUrl Link to a playbook for resolving the issue that triggered this alert. thresholdType The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired. thresholdValue The metric value, above or below which the alert should be triggered. warningEnumList Required.
const
EnterpriseCrmEventbusProtoTaskAlertConfigResponse.fromMap(Map<String, dynamic> map)
factory

Properties

aggregationPeriod → Input<String>
The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
final
alertDisabled → Input<bool>
Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
final
alertName → Input<String>
A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
final
clientId → Input<String>
Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
final
durationThresholdMs → Input<String>
Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
final
errorEnumList → Input<EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumListResponse>
final
hashCode → int
The hash code for this object.
no setterinherited
metricType → Input<String>
final
numAggregationPeriods → Input<int>
For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
final
onlyFinalAttempt → Input<bool>
Only count final task attempts, not retries.
final
playbookUrl → Input<String>
Link to a playbook for resolving the issue that triggered this alert.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
thresholdType → Input<String>
The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
final
thresholdValue → Input<EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValueResponse>
The metric value, above or below which the alert should be triggered.
final
warningEnumList → Input<EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumListResponse>
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited