DataLakeAnalyticsUSQLActivity Class
Data Lake Analytics U-SQL activity.
All required parameters must be populated in order to send to Azure.
- Inheritance
-
azure.synapse.artifacts.models._models_py3.ExecutionActivityDataLakeAnalyticsUSQLActivity
Constructor
DataLakeAnalyticsUSQLActivity(*, name: str, script_path: object, script_linked_service: LinkedServiceReference, additional_properties: Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, degree_of_parallelism: object | None = None, priority: object | None = None, parameters: Dict[str, object] | None = None, runtime_version: object | None = None, compilation_mode: object | None = None, **kwargs)
Parameters
Name | Description |
---|---|
additional_properties
Required
|
Unmatched properties from the message are deserialized to this collection. |
name
Required
|
Required. Activity name. |
type
Required
|
Required. Type of activity.Constant filled by server. |
description
Required
|
Activity description. |
depends_on
Required
|
Activity depends on condition. |
user_properties
Required
|
Activity user properties. |
linked_service_name
Required
|
Linked service reference. |
policy
Required
|
Activity policy. |
script_path
Required
|
Required. Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string). |
script_linked_service
Required
|
Required. Script linked service reference. |
degree_of_parallelism
Required
|
The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1. |
priority
Required
|
Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1. |
parameters
Required
|
Parameters for U-SQL job request. |
runtime_version
Required
|
Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string). |
compilation_mode
Required
|
Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string). |
Keyword-Only Parameters
Name | Description |
---|---|
name
Required
|
|
script_path
Required
|
|
script_linked_service
Required
|
|
additional_properties
Required
|
|
description
Required
|
|
depends_on
Required
|
|
user_properties
Required
|
|
linked_service_name
Required
|
|
policy
Required
|
|
degree_of_parallelism
Required
|
|
priority
Required
|
|
parameters
Required
|
|
runtime_version
Required
|
|
compilation_mode
Required
|
|
Methods
as_dict |
Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file:
If you want XML serialization, you can pass the kwargs is_xml=True. |
deserialize |
Parse a str using the RestAPI syntax and return a model. |
enable_additional_properties_sending | |
from_dict |
Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True. |
validate |
Validate this model recursively and return a list of ValidationError. |
as_dict
Return a dict that can be JSONify using json.dump.
Advanced usage might optionally use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parameters
Name | Description |
---|---|
key_transformer
|
<xref:function>
A key transformer function. |
keep_readonly
|
default value: True
|
Returns
Type | Description |
---|---|
A dict JSON compatible object |
deserialize
Parse a str using the RestAPI syntax and return a model.
deserialize(data, content_type=None)
Parameters
Name | Description |
---|---|
data
Required
|
A str using RestAPI structure. JSON by default. |
content_type
|
JSON by default, set application/xml if XML. default value: None
|
Returns
Type | Description |
---|---|
An instance of this model |
Exceptions
Type | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Parameters
Name | Description |
---|---|
data
Required
|
A dict using RestAPI structure |
content_type
|
JSON by default, set application/xml if XML. default value: None
|
key_extractors
|
default value: None
|
Returns
Type | Description |
---|---|
An instance of this model |
Exceptions
Type | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model()
serialize
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Parameters
Name | Description |
---|---|
keep_readonly
|
If you want to serialize the readonly attributes default value: False
|
Returns
Type | Description |
---|---|
A dict JSON compatible object |
validate
Validate this model recursively and return a list of ValidationError.
validate()
Returns
Type | Description |
---|---|
A list of validation error |
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for