Feedback Edit

CustomActivity Class

  • Reference

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: 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, resource_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, folder_path: Optional[object] = None, reference_objects: Optional[azure.synapse.artifacts.models._models_py3.CustomActivityReferenceObject] = None, extended_properties: Optional[Dict[str, object]] = None, retention_time_in_days: Optional[object] = 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.

command
object
Required

Required. Command for custom activity Type: string (or Expression with resultType string).

resource_linked_service
LinkedServiceReference
Required

Resource linked service reference.

folder_path
object
Required

Folder path for resource files Type: string (or Expression with resultType string).

reference_objects
CustomActivityReferenceObject
Required

Reference objects.

extended_properties
dict[str, object]
Required

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
object
Required

The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).