Share via

DatabricksSparkPythonActivity Class

  • Reference

DatabricksSparkPython activity.

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

Constructor

DatabricksSparkPythonActivity(*, name: str, python_file: MutableMapping[str, Any], additional_properties: Dict[str, 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, parameters: List[MutableMapping[str, Any]] | None = None, libraries: List[Dict[str, 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
str or ActivityState

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
str or ActivityOnInactiveMarkAs

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
list[ActivityDependency]

Activity depends on condition.

Default value: None
user_properties
list[UserProperty]

Activity user properties.

Default value: None
linked_service_name
LinkedServiceReference

Linked service reference.

Default value: None
policy
ActivityPolicy

Activity policy.

Default value: None
python_file
<xref:JSON>

The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string). Required.
parameters
list[<xref:JSON>]

Command line parameters that will be passed to the Python file.

Default value: None
libraries
list[dict[str, <xref:JSON>]]

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

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
str or ActivityState

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
str or ActivityOnInactiveMarkAs

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
list[ActivityDependency]

Activity depends on condition.
user_properties
list[UserProperty]

Activity user properties.
linked_service_name
LinkedServiceReference

Linked service reference.
policy
ActivityPolicy

Activity policy.
python_file
<xref:JSON>

The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string). Required.
parameters
list[<xref:JSON>]

Command line parameters that will be passed to the Python file.
libraries
list[dict[str, <xref:JSON>]]

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