Databricks SDK for JavaScript
    Preparing search index...

    Interface ListEventsRequest

    interface ListEventsRequest {
        clusterId?: string;
        endTime?: bigint;
        eventTypes?: ClusterEventType_ClusterEventType[];
        limit?: bigint;
        offset?: bigint;
        order?: GetEventsOrder;
        pageSize?: number;
        pageToken?: string;
        startTime?: bigint;
    }
    Index

    Properties

    clusterId? endTime? eventTypes? limit? offset? order? pageSize? pageToken? startTime?

    Properties

    clusterId?: string

    The ID of the cluster to retrieve events about.

    endTime?: bigint

    The end time in epoch milliseconds. If empty, returns events up to the current time.

    eventTypes?: ClusterEventType_ClusterEventType[]

    An optional set of event types to filter on. If empty, all event types are returned.

    limit?: bigint

    Deprecated: use page_token in combination with page_size instead.

    The maximum number of events to include in a page of events. Defaults to 50, and maximum allowed value is 500.

    offset?: bigint

    Deprecated: use page_token in combination with page_size instead.

    The offset in the result set. Defaults to 0 (no offset). When an offset is specified and the results are requested in descending order, the end_time field is required.

    order?: GetEventsOrder

    The order to list events in; either "ASC" or "DESC". Defaults to "DESC".

    pageSize?: number

    The maximum number of events to include in a page of events. The server may further constrain the maximum number of results returned in a single page. If the page_size is empty or 0, the server will decide the number of results to be returned. The field has to be in the range [0,500]. If the value is outside the range, the server enforces 0 or 500.

    pageToken?: string

    Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of events respectively. If page_token is empty, the first page is returned.

    startTime?: bigint

    The start time in epoch milliseconds. If empty, returns events starting from the beginning of time.

    Settings

    Member Visibility

    On This Page

    Properties