Databricks SDK for JavaScript
    Preparing search index...

    Interface CreateIndexRequest

    AIP-133 conformant Create. The index is nested under index; parent carries the endpoint path; index_id is the user-supplied Unity Catalog table name. The server composes Index.name from parent and index_id; any client-supplied index.name is ignored.

    interface CreateIndexRequest {
        index?: Index;
        indexId?: string;
        parent?: string;
    }
    Index

    Properties

    index? indexId? parent?

    Properties

    index?: Index

    The Index resource to create. Fields other than index.name carry the desired configuration; index.name is server-assigned from parent and index_id.

    indexId?: string

    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list index_id as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE.

    parent?: string

    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}

    Settings

    Member Visibility

    On This Page

    Properties