Package version:

Interface DatabricksNotebookActivity

DatabricksNotebook activity.

interface DatabricksNotebookActivity {
    baseParameters?: {
        [propertyName: string]: any;
    };
    dependsOn?: ActivityDependency[];
    description?: string;
    libraries?: {
        [propertyName: string]: any;
    }[];
    linkedServiceName?: LinkedServiceReference;
    name: string;
    notebookPath: any;
    onInactiveMarkAs?: string;
    policy?: ActivityPolicy;
    state?: string;
    type: "DatabricksNotebook";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

baseParameters? dependsOn? description? libraries? linkedServiceName? name notebookPath onInactiveMarkAs? policy? state? type userProperties?

Properties

OptionalbaseParameters

baseParameters?: {
    [propertyName: string]: any;
}

Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

Optionallibraries

libraries?: {
    [propertyName: string]: any;
}[]

A list of libraries to be installed on the cluster that will execute the job.

OptionallinkedServiceName

linkedServiceName?: LinkedServiceReference

Linked service reference.

name

name: string

Activity name.

notebookPath

notebookPath: any

The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

Optionalpolicy

policy?: ActivityPolicy

Activity policy.

Optionalstate

state?: string

Activity state. This is an optional property and if not provided, the state will be Active by default.

type

type

Polymorphic discriminator, which specifies the different types this object can be

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility