Share via

HDInsightSparkActivity Class

HDInsight Spark activity.

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

Constructor

HDInsightSparkActivity(*, name: str, root_path: MutableMapping[str, Any], entry_file_path: 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, arguments: List[MutableMapping[str, Any]] | None = None, get_debug_info: str | _models.HDInsightActivityDebugInfoOption | None = None, spark_job_linked_service: _models.LinkedServiceReference | None = None, class_name: str | None = None, proxy_user: MutableMapping[str, Any] | None = None, spark_config: 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
root_path
<xref:JSON>

The root path in 'sparkJobLinkedService' for all the job's files. Type: string (or Expression with resultType string). Required.
entry_file_path
<xref:JSON>

The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string). Required.
arguments
list[<xref:JSON>]

The user-specified arguments to HDInsightSparkActivity.

Default value: None
get_debug_info
str or HDInsightActivityDebugInfoOption

Debug info option. Known values are: "None", "Always", and "Failure".

Default value: None
spark_job_linked_service
LinkedServiceReference

The storage linked service for uploading the entry file and dependencies, and for receiving logs.

Default value: None
class_name
str

The application's Java/Spark main class.

Default value: None
proxy_user
<xref:JSON>

The user to impersonate that will execute the job. Type: string (or Expression with resultType string).

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

Spark configuration property.

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.
root_path
<xref:JSON>

The root path in 'sparkJobLinkedService' for all the job's files. Type: string (or Expression with resultType string). Required.
entry_file_path
<xref:JSON>

The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string). Required.
arguments
list[<xref:JSON>]

The user-specified arguments to HDInsightSparkActivity.
get_debug_info
str or HDInsightActivityDebugInfoOption

Debug info option. Known values are: "None", "Always", and "Failure".
spark_job_linked_service
LinkedServiceReference

The storage linked service for uploading the entry file and dependencies, and for receiving logs.
class_name
str

The application's Java/Spark main class.
proxy_user
<xref:JSON>

The user to impersonate that will execute the job. Type: string (or Expression with resultType string).
spark_config
dict[str, <xref:JSON>]

Spark configuration property.