Databricks SDK for JavaScript
    Preparing search index...

    Interface CronSchedule

    A cron-based schedule trigger for batch materialization.

    interface CronSchedule {
        cronExpression?: string;
        mode?: CronSchedule_Mode;
        paused?: boolean;
        timezoneId?: string;
    }
    Index

    Properties

    cronExpression? mode? paused? timezoneId?

    Properties

    cronExpression?: string

    The cron expression defining the schedule (e.g., "0 0 * * *" for daily at midnight). The schedule is interpreted in timezone_id (defaults to UTC). Required when mode is MANUAL (or unset). Left empty when mode is DERIVED, where the service computes it (aligned to UTC) from the features' window timing and fills it in on the response.

    mode?: CronSchedule_Mode

    How the schedule is determined. Defaults to MANUAL when unset.

    paused?: boolean

    Whether automatic materialization is paused. Defaults to false. Supported only for materializations in a materialization set. Use the UpdateMaterializationSet API to pause or resume the set.

    Pausing does not cancel running or queued runs. Runs can still be triggered through the TriggerMaterializationSet API. Resuming does not submit a run. Creating a paused materialization skips its initial run.

    timezoneId?: string

    A Java timezone ID. The schedule is resolved with respect to this timezone. Defaults to UTC when omitted. Can only be configured for MANUAL schedules; DERIVED schedules are always aligned to UTC.

    Settings

    Member Visibility

    On This Page

    Properties