Databricks SDK for JavaScript
    Preparing search index...

    Interface SubmitRunRequest

    interface SubmitRunRequest {
        accessControlList?: AccessControlRequest[];
        budgetPolicyId?: string;
        emailNotifications?: JobEmailNotifications;
        environments?: JobEnvironment[];
        gitSource?: GitSource;
        health?: JobsHealthRules;
        idempotencyToken?: string;
        notificationSettings?: NotificationSettings;
        queue?: QueueSettings;
        runAs?: JobRunAs;
        runName?: string;
        tasks?: RunTaskSettings[];
        timeoutSeconds?: number;
        usagePolicyId?: string;
        webhookNotifications?: WebhookNotifications;
    }
    Index

    Properties

    accessControlList? budgetPolicyId? emailNotifications? environments? gitSource? health? idempotencyToken? notificationSettings? queue? runAs? runName? tasks? timeoutSeconds? usagePolicyId? webhookNotifications?

    Properties

    accessControlList?: AccessControlRequest[]

    List of permissions to set on the job.

    budgetPolicyId?: string

    The user specified id of the budget policy to use for this one-time run. If not specified, the run will be not be attributed to any budget policy.

    emailNotifications?: JobEmailNotifications

    An optional set of email addresses notified when the run begins or completes.

    environments?: JobEnvironment[]

    A list of task execution environment specifications that can be referenced by tasks of this run.

    gitSource?: GitSource

    An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.

    If git_source is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting source to WORKSPACE on the task.

    Note: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, git_source must be defined on the job.

    health?: JobsHealthRules
    idempotencyToken?: string

    An optional token that can be used to guarantee the idempotency of job run requests. If a run with the provided token already exists, the request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted, an error is returned.

    If you specify the idempotency token, upon failure you can retry until the request succeeds. guarantees that exactly one run is launched with that idempotency token.

    This token must have at most 64 characters.

    For more information, see How to ensure idempotency for jobs.

    notificationSettings?: NotificationSettings

    Optional notification settings that are used when sending notifications to each of the email_notifications and webhook_notifications for this run.

    queue?: QueueSettings

    The queue settings of the one-time run.

    runAs?: JobRunAs

    Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who submits the request.

    runName?: string

    An optional name for the run. The default value is Untitled.

    tasks?: RunTaskSettings[]
    timeoutSeconds?: number

    An optional timeout applied to each run of this job. A value of 0 means no timeout.

    usagePolicyId?: string

    The user specified id of the usage policy to use for this one-time run. If not specified, a default usage policy may be applied when creating or modifying the job.

    webhookNotifications?: WebhookNotifications

    A collection of system notification IDs to notify when the run begins or completes.

    Settings

    Member Visibility

    On This Page

    Properties