Skip to main content

Interface: ResourceEntry

Interface: ResourceEntry

Internal representation of a resource in the registry. Extends ResourceRequirement with resolution state and plugin ownership.

Extends

Properties

alias

alias: string;

Human-readable label for UI/display only.

Inherited from

ResourceRequirement.alias


description

description: string;

Human-readable description of why this resource is needed.

Inherited from

ResourceRequirement.description


fields

fields: Record<string, ResourceFieldEntry>;

Map of field name to field entry. Required at runtime.

Inherited from

ResourceRequirement.fields


permission

permission: ResourcePermission;

Required permission level for the resource (narrowed to union)

Inherited from

ResourceRequirement.permission


permissionSources?

optional permissionSources: Record<string, ResourcePermission>;

Per-plugin permission tracking. Maps plugin name to the permission it originally requested. Populated when multiple plugins share the same resource.


plugin

plugin: string;

Plugin(s) that require this resource (comma-separated if multiple)


required

required: boolean;

Whether the resource is mandatory at runtime.

Inherited from

ResourceRequirement.required


resolved

resolved: boolean;

Whether the resource has been resolved (all field env vars set)


resourceKey

resourceKey: string;

Stable key for machine use: deduplication, env naming, composite keys, app.yaml.

Inherited from

ResourceRequirement.resourceKey


type

type: ResourceType;

Type of Databricks resource required (narrowed to enum)

Inherited from

ResourceRequirement.type


values?

optional values: Record<string, string>;

Resolved value per field name. Populated by validate() when all field env vars are set.

Databricks Developer Hub

Ready to ship your next agentic app in minutes?

Read docs