View Source GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoTaskAlertConfig (google_api_integrations v0.13.0)

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

Attributes

  • aggregationPeriod (type: String.t, default: nil) - 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 (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 in within the scope of the containing workflow.
  • clientId (type: String.t, default: nil) - Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
  • durationThresholdMs (type: String.t, default: nil) - 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 (type: GoogleApi.Integrations.V1alpha.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) - Only count final task 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 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.V1alpha.Model.EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue.t, default: nil) - The metric value, above or below which the alert should be triggered.
  • warningEnumList (type: GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList.t, default: nil) -

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoTaskAlertConfig{
    aggregationPeriod: String.t() | nil,
    alertDisabled: boolean() | nil,
    alertName: String.t() | nil,
    clientId: String.t() | nil,
    durationThresholdMs: String.t() | nil,
    errorEnumList:
      GoogleApi.Integrations.V1alpha.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.V1alpha.Model.EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue.t()
      | nil,
    warningEnumList:
      GoogleApi.Integrations.V1alpha.Model.EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList.t()
      | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.