Databricks SDK for JavaScript
    Preparing search index...

    Interface ListPipelineEventsRequest

    The request/response messages for the ListPipelines API. The default behavior is to return the 25 newest events in timestamp descending order for the given pipeline.

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

    Properties

    filter? maxResults? orderBy? pageToken? pipelineId?

    Properties

    filter?: string

    Criteria to select a subset of results, expressed using a SQL-like syntax. The supported filters are:

    1. level='INFO' (or WARN or ERROR)
    2. level in ('INFO', 'WARN')
    3. id='[event-id]'
    4. timestamp > 'TIMESTAMP' (or >=,<,<=,=)

    Composite expressions are supported, for example: level in ('ERROR', 'WARN') AND timestamp> '2021-07-22T06:37:33.083Z'

    maxResults?: number

    Max 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.

    orderBy?: string[]

    A string indicating a sort order by timestamp for the results, for example, ["timestamp asc"]. The sort order can be ascending or descending. By default, events are returned in descending order by timestamp.

    pageToken?: string

    Page token returned by previous call. This field is mutually exclusive with all fields in this request except max_results. An error is returned if any fields other than max_results are set when this field is set.

    pipelineId?: string

    The pipeline to return events for.

    Settings

    Member Visibility

    On This Page

    Properties