HDInsightHiveActivity Class

Reference

HDInsight Hive activity type.

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

Inheritance: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

HDInsightHiveActivity

Constructor

HDInsightHiveActivity(*, name: str, 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, storage_linked_services: List[_models.LinkedServiceReference] | None = None, arguments: List[MutableMapping[str, Any]] | None = None, get_debug_info: str | _models.HDInsightActivityDebugInfoOption | None = None, script_path: MutableMapping[str, Any] | None = None, script_linked_service: _models.LinkedServiceReference | None = None, defines: Dict[str, MutableMapping[str, Any]] | None = None, variables: Dict[str, MutableMapping[str, Any]] | None = None, query_timeout: int | 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.
name	str Activity name. 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.
storage_linked_services	list[LinkedServiceReference] Storage linked service references.
arguments	list[<xref:JSON>] User specified arguments to HDInsightActivity.
get_debug_info	str or HDInsightActivityDebugInfoOption Debug info option. Known values are: "None", "Always", and "Failure".
script_path	<xref:JSON> Script path. Type: string (or Expression with resultType string).
script_linked_service	LinkedServiceReference Script linked service reference.
defines	dict[str, <xref:JSON>] Allows user to specify defines for Hive job request.
variables	dict[str, <xref:JSON>] User specified arguments under hivevar namespace.
query_timeout	int Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package).

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.
storage_linked_services	list[LinkedServiceReference] Storage linked service references.
arguments	list[<xref:JSON>] User specified arguments to HDInsightActivity.
get_debug_info	str or HDInsightActivityDebugInfoOption Debug info option. Known values are: "None", "Always", and "Failure".
script_path	<xref:JSON> Script path. Type: string (or Expression with resultType string).
script_linked_service	LinkedServiceReference Script linked service reference.
defines	dict[str, <xref:JSON>] Allows user to specify defines for Hive job request.
variables	dict[str, <xref:JSON>] User specified arguments under hivevar namespace.
query_timeout	int Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package).

Share via

HDInsightHiveActivity Class

Constructor

Keyword-Only Parameters

Variables

Additional resources