Databricks SDK for JavaScript
    Preparing search index...

    Interface ListPipelinesRequest

    The request/response messages for the ListPipelines API. The default behavior is to return the 25 first pipelines in ascending order of pipeline id.

    interface ListPipelinesRequest {
        filter?: string;
        maxResults?: number;
        orderBy?: string[];
        pageToken?: string;
    }
    Index

    Properties

    filter? maxResults? orderBy? pageToken?

    Properties

    filter?: string

    Select a subset of results based on the specified criteria. The supported filters are:

    • notebook='<path>' to select pipelines that reference the provided notebook path.
    • name LIKE '[pattern]' to select pipelines with a name that matches pattern. Wildcards are supported, for example: name LIKE '%shopping%'

    Composite filters are not supported. This field is optional.

    maxResults?: number

    The maximum number of entries to return in a single page. The system may return fewer than max_results events in a response, even if there are more events available. This field is optional. The default value is 25. The maximum value is 100. An error is returned if the value of max_results is greater than 100.

    orderBy?: string[]

    A list of strings specifying the order of results. Supported order_by fields are id and name. The default is id asc. This field is optional.

    pageToken?: string

    Page token returned by previous call

    Settings

    Member Visibility

    On This Page

    Properties