Interface SettingsMetadata

interface SettingsMetadata {
    description?: string;
    displayName?: string;
    docsLink?: string;
    name?: string;
    previewPhase?: PreviewPhase;
    type?: string;
}

Properties

description?: string

Setting description for what this setting controls

displayName?: string

Human-readable display name for the setting or feature preview. This field may be unset if no display name is available.

docsLink?: string

Link to databricks documentation for the setting

name?: string

Name of the setting.

previewPhase?: PreviewPhase

Preview phase for feature preview settings. This field is not set for non-preview settings.

type?: string

Sample message depicting the type of the setting. To set this setting, the value sent must match this type.