Databricks SDK for JavaScript
    Preparing search index...

    Interface ListRunsRequest

    Lists runs from most recently started to least.

    interface ListRunsRequest {
        expandTasks?: boolean;
        jobId?: bigint;
        limit?: number;
        offset?: number;
        pageToken?: string;
        runType?: RunType;
        startTimeFrom?: bigint;
        startTimeTo?: bigint;
        stateConstraint?:
            | { $case: "activeOnly"; activeOnly: boolean }
            | { $case: "completedOnly"; completedOnly: boolean };
    }
    Index

    Properties

    expandTasks?: boolean

    Whether to include task and cluster details in the response. Note that only the first 100 elements will be shown. Use :method:jobs/getrun to paginate through all tasks and clusters.

    jobId?: bigint

    The job for which to list runs. If omitted, the Jobs service lists runs from all jobs.

    limit?: number

    The number of runs to return. This value must be greater than 0 and less than 25. The default value is 20. If a request specifies a limit of 0, the service instead uses the maximum limit.

    offset?: number

    The offset of the first run to return, relative to the most recent run. Deprecated since June 2023. Use page_token to iterate through the pages instead.

    pageToken?: string

    Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of runs respectively.

    runType?: RunType

    The type of runs to return. For a description of run types, see :method:jobs/getRun.

    startTimeFrom?: bigint

    Show runs that started at or after this value. The value must be a UTC timestamp in milliseconds. Can be combined with start_time_to to filter by a time range.

    startTimeTo?: bigint

    Show runs that started at or before this value. The value must be a UTC timestamp in milliseconds. Can be combined with start_time_from to filter by a time range.

    stateConstraint?:
        | { $case: "activeOnly"; activeOnly: boolean }
        | { $case: "completedOnly"; completedOnly: boolean }

    Type Declaration

    • { $case: "activeOnly"; activeOnly: boolean }
      • $case: "activeOnly"
      • activeOnly: boolean

        If active_only is true, only active runs are included in the results; otherwise, lists both active and completed runs. An active run is a run in the QUEUED, PENDING, RUNNING, or TERMINATING. This field cannot be true when completed_only is true.

    • { $case: "completedOnly"; completedOnly: boolean }
      • $case: "completedOnly"
      • completedOnly: boolean

        If completed_only is true, only completed runs are included in the results; otherwise, lists both active and completed runs. This field cannot be true when active_only is true.