Databricks SDK for JavaScript
    Preparing search index...

    Interface ListVolumesRequest

    interface ListVolumesRequest {
        catalogName?: string;
        includeBrowse?: boolean;
        maxResults?: number;
        pageToken?: string;
        schemaName?: string;
    }
    Index

    Properties

    catalogName? includeBrowse? maxResults? pageToken? schemaName?

    Properties

    catalogName?: string

    The identifier of the catalog

    includeBrowse?: boolean

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

    maxResults?: number

    Maximum number of volumes to return (page length).

    If not set, the page length is set to a server configured value (10000, as of 1/29/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 1/29/2024);
    • when set to 0, the page length is set to a server configured value (10000, as of 1/29/2024) (recommended);
    • when set to a value less than 0, an invalid parameter error is returned;

    Note: this parameter controls only the maximum number of volumes to return. The actual number of volumes returned in a page may be smaller than this value, including 0, even if there are more pages.

    pageToken?: string

    Opaque token returned by a previous request. It must be included in the request to retrieve the next page of results (pagination).

    schemaName?: string

    The identifier of the schema

    Settings

    Member Visibility

    On This Page

    Properties