Databricks SDK for JavaScript
    Preparing search index...

    Defines when a detection rule executes.

    A batch rule sets exactly one of at_least_every or cron_expression. A streaming rule runs continuously and sets no timing; it accepts only enabled, and an omitted schedule means enabled. The server rejects any other combination. enabled is orthogonal to the timing.

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

    Properties

    Properties

    enabled?: boolean

    Sets 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

        Defines the minimum cadence as a duration string. It may contain components for days, hours, minutes, and seconds (e.g. 5d, 5d3h, 3d2h5m12s, 12m16s).

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

        Defines the schedule using a Quartz cron expression.

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

        Runs the rule continuously. Detection rules do not accept it: batch rules reject it, and streaming rules run continuously without it.