Databricks SDK for JavaScript
    Preparing search index...

    Interface ListRegisteredModelsRequest

    interface ListRegisteredModelsRequest {
        catalogName?: string;
        includeBrowse?: boolean;
        maxResults?: bigint;
        pageToken?: string;
        schemaName?: string;
    }
    Index

    Properties

    catalogName? includeBrowse? maxResults? pageToken? schemaName?

    Properties

    catalogName?: string

    The identifier of the catalog under which to list registered models. If specified, schema_name must be specified.

    includeBrowse?: boolean

    Whether to include registered models in the response for which the principal can only access selective metadata for

    maxResults?: bigint

    Max number of registered models to return.

    If both catalog and schema are specified:

    • when max_results is not specified, the page length is set to a server configured value (10000, as of 4/2/2024).
    • when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 4/2/2024);
    • when set to 0, the page length is set to a server configured value (10000, as of 4/2/2024);
    • when set to a value less than 0, an invalid parameter error is returned;

    If neither schema nor catalog is specified:

    • when max_results is not specified, the page length is set to a server configured value (100, as of 4/2/2024).
    • when set to a value greater than 0, the page length is the minimum of this value and a server configured value (1000, as of 4/2/2024);
    • when set to 0, the page length is set to a server configured value (100, as of 4/2/2024);
    • when set to a value less than 0, an invalid parameter error is returned;
    pageToken?: string

    Opaque token to send for the next page of results (pagination).

    schemaName?: string

    The identifier of the schema under which to list registered models. If specified, catalog_name must be specified.

    Settings

    Member Visibility

    On This Page

    Properties