Feedback Edit

HDInsightHiveActivity Class

  • Reference

HDInsight Hive activity type.

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

Inheritance
azure.synapse.artifacts.models._models_py3.ExecutionActivity
HDInsightHiveActivity

Constructor

HDInsightHiveActivity(*, name: str, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, storage_linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, arguments: Optional[List[object]] = None, get_debug_info: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HDInsightActivityDebugInfoOption]] = None, script_path: Optional[object] = None, script_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, defines: Optional[Dict[str, object]] = None, variables: Optional[List[object]] = None, query_timeout: Optional[int] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

name
str
Required

Required. Activity name.

type
str
Required

Required. Type of activity.Constant filled by server.

description
str
Required

Activity description.

depends_on
list[ActivityDependency]
Required

Activity depends on condition.

user_properties
list[UserProperty]
Required

Activity user properties.

linked_service_name
LinkedServiceReference
Required

Linked service reference.

policy
ActivityPolicy
Required

Activity policy.

storage_linked_services
list[LinkedServiceReference]
Required

Storage linked service references.

arguments
list[object]
Required

User specified arguments to HDInsightActivity.

get_debug_info
str or HDInsightActivityDebugInfoOption
Required

Debug info option. Possible values include: "None", "Always", "Failure".

script_path
object
Required

Script path. Type: string (or Expression with resultType string).

script_linked_service
LinkedServiceReference
Required

Script linked service reference.

defines
dict[str, object]
Required

Allows user to specify defines for Hive job request.

variables
list[object]
Required

User specified arguments under hivevar namespace.

query_timeout
int
Required

Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package).