SwitchActivity Class

This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

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

Inheritance

azure.synapse.artifacts.models._models_py3.Activity

SwitchActivity

Constructor

SwitchActivity(*, name: str, on: azure.synapse.artifacts.models._models_py3.Expression, 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, cases: Optional[List[azure.synapse.artifacts.models._models_py3.SwitchCase]] = None, default_activities: Optional[List[azure.synapse.artifacts.models._models_py3.Activity]] = 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.

on

Expression

Required

Required. An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.

cases

list[SwitchCase]

Required

List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.

default_activities

list[Activity]

Required

List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.