Databricks SDK for JavaScript
    Preparing search index...

    Interface JobEmailNotifications

    interface JobEmailNotifications {
        noAlertForSkippedRuns?: boolean;
        onDurationWarningThresholdExceeded?: string[];
        onFailure?: string[];
        onStart?: string[];
        onStreamingBacklogExceeded?: string[];
        onSuccess?: string[];
    }
    Index

    Properties

    noAlertForSkippedRuns? onDurationWarningThresholdExceeded? onFailure? onStart? onStreamingBacklogExceeded? onSuccess?

    Properties

    noAlertForSkippedRuns?: boolean

    If true, do not send email to recipients specified in on_failure if the run is skipped. This field is deprecated. Please use the notification_settings.no_alert_for_skipped_runs field.

    onDurationWarningThresholdExceeded?: string[]

    A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the RUN_DURATION_SECONDS metric in the health field. If no rule for the RUN_DURATION_SECONDS metric is specified in the health field for the job, notifications are not sent.

    onFailure?: string[]

    A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an INTERNAL_ERROR life_cycle_state or a FAILED, or TIMED_OUT result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.

    onStart?: string[]

    A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.

    onStreamingBacklogExceeded?: string[]

    A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the health field using the following metrics: STREAMING_BACKLOG_BYTES, STREAMING_BACKLOG_RECORDS, STREAMING_BACKLOG_SECONDS, or STREAMING_BACKLOG_FILES. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.

    onSuccess?: string[]

    A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a TERMINATED life_cycle_state and a SUCCESS result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.

    Settings

    Member Visibility

    On This Page

    Properties