Databricks SDK for JavaScript
    Preparing search index...

    Interface AssetLink

    A reference or provenance link from a page to an asset. Links are immutable; to change the target, delete and re-create the link.

    interface AssetLink {
        assetId?: string;
        assetScopeId?: string;
        assetType?: AssetType;
        createTime?: Instant;
        name?: string;
    }
    Index

    Properties

    assetId? assetScopeId? assetType? createTime? name?

    Properties

    assetId?: string

    Target identifier within asset_scope_id. Required on create. The accepted format depends on asset_type; see the identifier rules on each AssetType. For Databricks assets, pass the bare identifier rather than a resource name such as pages/{page_id} or queries/{query_id}. External assets use the full URL. Create and Get return table FQNs, app UUIDs, query UUIDs, and native Genie space IDs.

    assetScopeId?: string

    Containing scope of the asset. Required on create for every asset type:

    • UC table: metastore UUID.
    • Workspace asset: decimal workspace ID string.
    • Account page or external URL: the calling account UUID. Pass the bare ID, without a resource-name prefix. Query and Genie links, dashboard UUID inputs, and app-name inputs require this scope to match the caller's workspace.
    assetType?: AssetType

    Kind of asset this link points to. Required on create; ASSET_TYPE_UNSPECIFIED is not a valid target type.

    createTime?: Instant

    Server-assigned creation time, formatted as an RFC 3339 timestamp in JSON.

    name?: string

    Resource name of the link. Server-assigned on create, immutable thereafter. Format: pages/{page_id}/asset-link-categories/{category}/asset-links/{link_id}, where category is SOURCE or RELATED_ASSETS and link_id is a server-generated UUID. Omit on create; use the returned name for Get/Delete.

    Settings

    Member Visibility

    On This Page

    Properties