HDInsightStreamingActivity Class
HDInsight streaming activity type.
All required parameters must be populated in order to send to server.
Constructor
HDInsightStreamingActivity(*, name: str, mapper: MutableMapping[str, Any], reducer: MutableMapping[str, Any], input: MutableMapping[str, Any], output: MutableMapping[str, Any], file_paths: List[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, storage_linked_services: List[_models.LinkedServiceReference] | None = None, arguments: List[MutableMapping[str, Any]] | None = None, get_debug_info: str | _models.HDInsightActivityDebugInfoOption | None = None, file_linked_service: _models.LinkedServiceReference | None = None, combiner: MutableMapping[str, Any] | None = None, command_environment: List[MutableMapping[str, Any]] | None = None, defines: Dict[str, MutableMapping[str, Any]] | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
name
|
Activity name. Required. |
|
description
|
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
|
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
|
|
storage_linked_services
|
Storage linked service references. Default value: None
|
|
arguments
|
list[<xref:JSON>]
User specified arguments to HDInsightActivity. Default value: None
|
|
get_debug_info
|
Debug info option. Known values are: "None", "Always", and "Failure". Default value: None
|
|
mapper
|
<xref:JSON>
Mapper executable name. Type: string (or Expression with resultType string). Required. |
|
reducer
|
<xref:JSON>
Reducer executable name. Type: string (or Expression with resultType string). Required. |
|
input
|
<xref:JSON>
Input blob path. Type: string (or Expression with resultType string). Required. |
|
output
|
<xref:JSON>
Output blob path. Type: string (or Expression with resultType string). Required. |
|
file_paths
|
list[<xref:JSON>]
Paths to streaming job files. Can be directories. Required. |
|
file_linked_service
|
Linked service reference where the files are located. Default value: None
|
|
combiner
|
<xref:JSON>
Combiner executable name. Type: string (or Expression with resultType string). Default value: None
|
|
command_environment
|
list[<xref:JSON>]
Command line environment values. Default value: None
|
|
defines
|
Allows user to specify defines for streaming job request. Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
name
|
Activity name. Required. |
|
type
|
Type of activity. Required. |
|
description
|
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
|
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. |
|
storage_linked_services
|
Storage linked service references. |
|
arguments
|
list[<xref:JSON>]
User specified arguments to HDInsightActivity. |
|
get_debug_info
|
Debug info option. Known values are: "None", "Always", and "Failure". |
|
mapper
|
<xref:JSON>
Mapper executable name. Type: string (or Expression with resultType string). Required. |
|
reducer
|
<xref:JSON>
Reducer executable name. Type: string (or Expression with resultType string). Required. |
|
input
|
<xref:JSON>
Input blob path. Type: string (or Expression with resultType string). Required. |
|
output
|
<xref:JSON>
Output blob path. Type: string (or Expression with resultType string). Required. |
|
file_paths
|
list[<xref:JSON>]
Paths to streaming job files. Can be directories. Required. |
|
file_linked_service
|
Linked service reference where the files are located. |
|
combiner
|
<xref:JSON>
Combiner executable name. Type: string (or Expression with resultType string). |
|
command_environment
|
list[<xref:JSON>]
Command line environment values. |
|
defines
|
Allows user to specify defines for streaming job request. |
