CustomActivity Class

Custom activity type.

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

Inheritance

azure.synapse.artifacts.models._models_py3.ExecutionActivity

CustomActivity

Constructor

CustomActivity(*, name: str, command: object, 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, resource_linked_service: LinkedServiceReference | None = None, folder_path: object | None = None, reference_objects: CustomActivityReferenceObject | None = None, extended_properties: Dict[str, object] | None = None, retention_time_in_days: object | None = None, **kwargs)

Parameters

Name	Description
additional_properties Required	dict[str, object] Unmatched properties from the message are deserialized to this collection.
name Required	str Required. Activity name.
type Required	str Required. Type of activity.Constant filled by server.
description Required	str Activity description.
depends_on Required	list[ActivityDependency] Activity depends on condition.
user_properties Required	list[UserProperty] Activity user properties.
linked_service_name Required	LinkedServiceReference Linked service reference.
policy Required	ActivityPolicy Activity policy.
command Required	object Required. Command for custom activity Type: string (or Expression with resultType string).
resource_linked_service Required	LinkedServiceReference Resource linked service reference.
folder_path Required	object Folder path for resource files Type: string (or Expression with resultType string).
reference_objects Required	CustomActivityReferenceObject Reference objects.
extended_properties Required	dict[str, object] User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.
retention_time_in_days Required	object The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).

Keyword-Only Parameters

Name	Description
name Required
command Required
additional_properties Required
description Required
depends_on Required
user_properties Required
linked_service_name Required
policy Required
resource_linked_service Required
folder_path Required
reference_objects Required
extended_properties Required
retention_time_in_days 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: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 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
dict	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	str A str using RestAPI structure. JSON by default.
content_type	str 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	dict A dict using RestAPI structure
content_type	str 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	bool If you want to serialize the readonly attributes default value: False

Returns

Type	Description
dict	A dict JSON compatible object

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type	Description
list	A list of validation error