Databricks SDK for JavaScript
    Preparing search index...

    Interface GetJobResponse

    Job was retrieved successfully.

    interface GetJobResponse {
        createdTime?: bigint;
        creatorUserName?: string;
        effectiveBudgetPolicyId?: string;
        effectiveUsagePolicyId?: string;
        hasMore?: boolean;
        jobId?: bigint;
        nextPageToken?: string;
        runAsUserName?: string;
        settings?: JobSettings;
        triggerState?: TriggerState;
    }
    Index

    Properties

    createdTime? creatorUserName? effectiveBudgetPolicyId? effectiveUsagePolicyId? hasMore? jobId? nextPageToken? runAsUserName? settings? triggerState?

    Properties

    createdTime?: bigint

    The time at which this job was created in epoch milliseconds (milliseconds since 1/1/1970 UTC).

    creatorUserName?: string

    The creator user name. This field won’t be included in the response if the user has already been deleted.

    effectiveBudgetPolicyId?: string

    The id of the budget policy used by this job for cost attribution purposes. This may be set through (in order of precedence):

    1. Budget admins through the account or workspace console
    2. Jobs UI in the job details page and Jobs API using budget_policy_id
    3. Inferred default based on accessible budget policies of the run_as identity on job creation or modification.
    effectiveUsagePolicyId?: string

    The id of the usage policy used by this job for cost attribution purposes.

    hasMore?: boolean

    Indicates if the job has more array properties (tasks, job_clusters) that are not shown. They can be accessed via :method:jobs/get endpoint. It is only relevant for API 2.2 :method:jobs/list requests with expand_tasks=true.

    jobId?: bigint

    The canonical identifier for this job.

    nextPageToken?: string

    A token that can be used to list the next page of array properties.

    runAsUserName?: string

    The email of an active workspace user or the application ID of a service principal that the job runs as. This value can be changed by setting the run_as field when creating or updating a job.

    By default, run_as_user_name is based on the current job settings and is set to the creator of the job if job access control is disabled or to the user with the is_owner permission if job access control is enabled.

    settings?: JobSettings

    Settings for this job and all of its runs. These settings can be updated using the resetJob method.

    triggerState?: TriggerState

    State of the trigger associated with the job.

    Settings

    Member Visibility

    On This Page

    Properties