ScriptActivity Class
Script activity type.
All required parameters must be populated in order to send to server.
Constructor
ScriptActivity(*, 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, script_block_execution_timeout: MutableMapping[str, Any] | None = None, scripts: List[_models.ScriptActivityScriptBlock] | None = None, log_settings: _models.ScriptActivityTypePropertiesLogSettings | None = None, return_multistatement_result: 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
|
|
script_block_execution_timeout
|
<xref:JSON>
ScriptBlock execution timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Default value: None
|
|
scripts
|
Array of script blocks. Type: array. Default value: None
|
|
log_settings
|
Log settings of script activity. Default value: None
|
|
return_multistatement_result
|
<xref:JSON>
Enable to retrieve result sets from multiple SQL statements and the number of rows affected by the DML statement. Supported connector: SnowflakeV2. Type: boolean (or Expression with resultType boolean). 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. |
|
script_block_execution_timeout
|
<xref:JSON>
ScriptBlock execution timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). |
|
scripts
|
Array of script blocks. Type: array. |
|
log_settings
|
Log settings of script activity. |
|
return_multistatement_result
|
<xref:JSON>
Enable to retrieve result sets from multiple SQL statements and the number of rows affected by the DML statement. Supported connector: SnowflakeV2. Type: boolean (or Expression with resultType boolean). |
