Databricks SDK for JavaScript
    Preparing search index...

    Interface Subscription

    interface Subscription {
        createdByUserId?: bigint;
        createTime?: Instant;
        dashboardId?: string;
        etag?: string;
        scheduleId?: string;
        skipNotify?: boolean;
        subscriber?: Subscription_Subscriber;
        subscriptionId?: string;
        updateTime?: Instant;
    }
    Index

    Properties

    createdByUserId? createTime? dashboardId? etag? scheduleId? skipNotify? subscriber? subscriptionId? updateTime?

    Properties

    createdByUserId?: bigint

    UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule.

    createTime?: Instant

    A timestamp indicating when the subscription was created.

    dashboardId?: string

    UUID identifying the dashboard to which the subscription belongs.

    etag?: string

    The etag for the subscription. Must be left empty on create, can be optionally provided on delete to ensure that the subscription has not been deleted since the last read.

    scheduleId?: string

    UUID identifying the schedule to which the subscription belongs.

    skipNotify?: boolean

    Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes. If not defined, defaults to false in the backend to match the current behavior (refresh and notify)

    subscriber?: Subscription_Subscriber

    Subscriber details for users and destinations to be added as subscribers to the schedule.

    subscriptionId?: string

    UUID identifying the subscription.

    updateTime?: Instant

    A timestamp indicating when the subscription was last updated.

    Settings

    Member Visibility

    On This Page

    Properties