Databricks SDK for JavaScript
    Preparing search index...

    Interface CreateAlertRequestAlert

    interface CreateAlertRequestAlert {
        condition?: AlertCondition;
        createTime?: Instant;
        customBody?: string;
        customSubject?: string;
        displayName?: string;
        id?: string;
        lifecycleState?: LifecycleState;
        notifyOnOk?: boolean;
        ownerUserName?: string;
        parentPath?: string;
        queryId?: string;
        secondsToRetrigger?: number;
        state?: AlertState;
        triggerTime?: Instant;
        updateTime?: Instant;
    }
    Index

    Properties

    condition? createTime? customBody? customSubject? displayName? id? lifecycleState? notifyOnOk? ownerUserName? parentPath? queryId? secondsToRetrigger? state? triggerTime? updateTime?

    Properties

    condition?: AlertCondition

    Trigger conditions of the alert.

    createTime?: Instant

    The timestamp indicating when the alert was created.

    customBody?: string

    Custom body of alert notification, if it exists. See here for custom templating instructions.

    customSubject?: string

    Custom subject of alert notification, if it exists. This can include email subject entries and Slack notification headers, for example. See here for custom templating instructions.

    displayName?: string

    The display name of the alert.

    id?: string

    UUID identifying the alert.

    lifecycleState?: LifecycleState

    The workspace state of the alert. Used for tracking trashed status.

    notifyOnOk?: boolean

    Whether to notify alert subscribers when alert returns back to normal.

    ownerUserName?: string

    The owner's username. This field is set to "Unavailable" if the user has been deleted.

    parentPath?: string

    The workspace path of the folder containing the alert.

    queryId?: string

    UUID of the query attached to the alert.

    secondsToRetrigger?: number

    Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.

    state?: AlertState

    Current state of the alert's trigger status. This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.

    triggerTime?: Instant

    Timestamp when the alert was last triggered, if the alert has been triggered before.

    updateTime?: Instant

    The timestamp indicating when the alert was updated.

    Settings

    Member Visibility

    On This Page

    Properties