Share via


DatabricksJobActivity Class

Databricks Job activity.

All required parameters must be populated in order to send to server.

Constructor

DatabricksJobActivity(*, name: str, job_id: MutableMapping[str, Any], additional_properties: dict[str, collections.abc.MutableMapping[str, Any]] | None = None, description: str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: list['_models.ActivityDependency'] | None = None, user_properties: list['_models.UserProperty'] | None = None, linked_service_name: _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy | None = None, job_parameters: dict[str, collections.abc.MutableMapping[str, Any]] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

Default value: None
name
str

Activity name. Required.

description
str

Activity description.

Default value: None
state

Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".

Default value: None
on_inactive_mark_as

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. Known values are: "Succeeded", "Failed", and "Skipped".

Default value: None
depends_on

Activity depends on condition.

Default value: None
user_properties

Activity user properties.

Default value: None
linked_service_name

Linked service reference.

Default value: None
policy

Activity policy.

Default value: None
job_id
<xref:JSON>

The Id of the Databricks Job to be executed. Type: string (or Expression with resultType string). Required.

job_parameters
dict[str, <xref:JSON>]

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

Default value: None

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

name
str

Activity name. Required.

type
str

Type of activity. Required.

description
str

Activity description.

state

Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".

on_inactive_mark_as

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. Known values are: "Succeeded", "Failed", and "Skipped".

depends_on

Activity depends on condition.

user_properties

Activity user properties.

linked_service_name

Linked service reference.

policy

Activity policy.

job_id
<xref:JSON>

The Id of the Databricks Job to be executed. Type: string (or Expression with resultType string). Required.

job_parameters
dict[str, <xref:JSON>]

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