EnterpriseCrmEventbusProtoWorkflowAlertConfigResponse class
Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
Constructors
-
EnterpriseCrmEventbusProtoWorkflowAlertConfigResponse({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 EnterpriseCrmEventbusProtoWorkflowAlertConfigResponse.
aggregationPeriodFor an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.alertDisabledSet to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.alertNameA name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.clientIdClient associated with this alert configuration.durationThresholdMsShould be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.errorEnumListRequired.metricTypeRequired.numAggregationPeriodsFor how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.onlyFinalAttemptFor either events or tasks, depending on the type of alert, count only final attempts, not retries.playbookUrlLink to a playbook for resolving the issue that triggered this alert.thresholdTypeThe threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.thresholdValueThe metric value, above or below which the alert should be triggered.warningEnumListRequired.const -
EnterpriseCrmEventbusProtoWorkflowAlertConfigResponse.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
aggregationPeriod
→ Input<
String> -
For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
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 within the scope of the workflow.
final
-
clientId
→ Input<
String> -
Client associated with this alert configuration.
final
-
durationThresholdMs
→ Input<
String> -
Should be specified only for *AVERAGE_DURATION and *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> -
For either events or tasks, depending on the type of alert, count only final 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, whether lower(expected_min) or upper(expected_max), 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