Databricks SDK for JavaScript
    Preparing search index...

    Interface Schedule

    Defines when a recurring job executes.

    Exactly one of the timing modes (at_least_every, cron_expression, continuous) must be set; combining them or setting none is rejected by the server. compute_group and enabled are orthogonal to the timing.

    interface Schedule {
        computeGroup?: string;
        enabled?: boolean;
        timing?:
            | { $case: "atLeastEvery"; atLeastEvery: string }
            | { $case: "cronExpression"; cronExpression: string }
            | { $case: "continuous"; continuous: boolean };
    }
    Index

    Properties

    computeGroup? enabled? timing?

    Properties

    computeGroup?: string

    dedicated, inherited, automatic, or a custom group name. Reads return the value as supplied. A rule whose schedule omits it runs on dedicated.

    enabled?: boolean

    Whether the job is scheduled to run. Defaults to true.

    timing?:
        | { $case: "atLeastEvery"; atLeastEvery: string }
        | { $case: "cronExpression"; cronExpression: string }
        | { $case: "continuous"; continuous: boolean }

    Type Declaration

    • { $case: "atLeastEvery"; atLeastEvery: string }
      • $case: "atLeastEvery"
      • atLeastEvery: string

        Duration string defining the minimum cadence. May contain components for days, hours, minutes, seconds (e.g. 5d, 5d3h, 3d2h5m12s, 12m16s).

    • { $case: "cronExpression"; cronExpression: string }
      • $case: "cronExpression"
      • cronExpression: string

        Quartz cron expression.

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

        Run continuously (sentinel — must be true when set in this branch).

    Settings

    Member Visibility

    On This Page

    Properties