Databricks SDK for JavaScript
    Preparing search index...

    Interface OptionSpec

    Spec of an allowed option on a securable kind and its attributes. This is mostly used by UI to provide user friendly hints and descriptions in order to facilitate the securable creation process.

    interface OptionSpec {
        allowedValues?: string[];
        defaultValue?: string;
        description?: string;
        hint?: string;
        isCopiable?: boolean;
        isCreatable?: boolean;
        isHidden?: boolean;
        isLoggable?: boolean;
        isRequired?: boolean;
        isSecret?: boolean;
        isUpdatable?: boolean;
        name?: string;
        oauthStage?: OptionSpec_OauthStage;
        type?: OptionSpec_OptionType;
    }
    Index

    Properties

    allowedValues? defaultValue? description? hint? isCopiable? isCreatable? isHidden? isLoggable? isRequired? isSecret? isUpdatable? name? oauthStage? type?

    Properties

    allowedValues?: string[]

    For drop down / radio button selections, UI will want to know the possible input values, it can also be used by other option types to limit input selections.

    defaultValue?: string

    The default value of the option, for example, value '443' for 'port' option.

    description?: string

    A concise user facing description of what the input value of this option should look like.

    hint?: string

    The hint is used on the UI to suggest what the input value can possibly be like, for example: example.com for 'host' option. Unlike default value, it will not be applied automatically without user input.

    isCopiable?: boolean

    Indicates whether an option should be displayed with copy button on the UI.

    isCreatable?: boolean

    Indicates whether an option can be provided by users in the create/update path of an entity.

    isHidden?: boolean

    Is the option value not user settable and is thus not shown on the UI.

    isLoggable?: boolean

    Specifies whether this option is safe to log, i.e. no sensitive information.

    isRequired?: boolean

    Is the option required.

    isSecret?: boolean

    Is the option value considered secret and thus redacted on the UI.

    isUpdatable?: boolean

    Is the option updatable by users.

    name?: string

    The unique name of the option.

    oauthStage?: OptionSpec_OauthStage

    Specifies when the option value is displayed on the UI within the OAuth flow.

    type?: OptionSpec_OptionType

    The type of the option.

    Settings

    Member Visibility

    On This Page

    Properties