View Source GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoWorkflowAlertConfig (google_api_integrations v0.6.0)

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

Attributes

  • aggregationPeriod (type: String.t, default: nil) - For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
  • alertDisabled (type: boolean(), default: nil) - Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
  • alertName (type: String.t, default: nil) - 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.
  • clientId (type: String.t, default: nil) - Client associated with this alert configuration.
  • durationThresholdMs (type: String.t, default: nil) - 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.
  • errorEnumList (type: GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList.t, default: nil) -
  • metricType (type: String.t, default: nil) -
  • numAggregationPeriods (type: integer(), default: nil) - For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
  • onlyFinalAttempt (type: boolean(), default: nil) - For either events or tasks, depending on the type of alert, count only final attempts, not retries.
  • playbookUrl (type: String.t, default: nil) - Link to a playbook for resolving the issue that triggered this alert.
  • thresholdType (type: String.t, default: nil) - 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.
  • thresholdValue (type: GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue.t, default: nil) - The metric value, above or below which the alert should be triggered.
  • warningEnumList (type: GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList.t, default: nil) -

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoWorkflowAlertConfig{
    aggregationPeriod: String.t() | nil,
    alertDisabled: boolean() | nil,
    alertName: String.t() | nil,
    clientId: String.t() | nil,
    durationThresholdMs: String.t() | nil,
    errorEnumList:
      GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList.t()
      | nil,
    metricType: String.t() | nil,
    numAggregationPeriods: integer() | nil,
    onlyFinalAttempt: boolean() | nil,
    playbookUrl: String.t() | nil,
    thresholdType: String.t() | nil,
    thresholdValue:
      GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue.t()
      | nil,
    warningEnumList:
      GoogleApi.Integrations.V1.Model.EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList.t()
      | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.