Package com.azure.analytics.synapse.artifacts.models

Class SwitchActivity

  • public class SwitchActivity
extends ControlActivity
    This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

    • Constructor Detail

      • SwitchActivity

        public SwitchActivity()

    • Method Detail

      • getOn

        public Expression getOn()
        Get the on property: 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.
        Returns:
        the on value.

      • setOn

        public SwitchActivity setOn​(Expression on)
        Set the on property: 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.
        Parameters:
        on - the on value to set.
        Returns:
        the SwitchActivity object itself.

      • getCases

        public List<SwitchCase> getCases()
        Get the cases property: 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.
        Returns:
        the cases value.

      • setCases

        public SwitchActivity setCases​(List<SwitchCase> cases)
        Set the cases property: 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.
        Parameters:
        cases - the cases value to set.
        Returns:
        the SwitchActivity object itself.

      • getDefaultActivities

        public List<Activity> getDefaultActivities()
        Get the defaultActivities property: 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.
        Returns:
        the defaultActivities value.

      • setDefaultActivities

        public SwitchActivity setDefaultActivities​(List<Activity> defaultActivities)
        Set the defaultActivities property: 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.
        Parameters:
        defaultActivities - the defaultActivities value to set.
        Returns:
        the SwitchActivity object itself.

      • setName

        public SwitchActivity setName​(String name)
        Set the name property: Activity name.
        Overrides:
        setName in class ControlActivity
        Parameters:
        name - the name value to set.
        Returns:
        the Activity object itself.

      • setDescription

        public SwitchActivity setDescription​(String description)
        Set the description property: Activity description.
        Overrides:
        setDescription in class ControlActivity
        Parameters:
        description - the description value to set.
        Returns:
        the Activity object itself.

      • setUserProperties

        public SwitchActivity setUserProperties​(List<UserProperty> userProperties)
        Set the userProperties property: Activity user properties.
        Overrides:
        setUserProperties in class ControlActivity
        Parameters:
        userProperties - the userProperties value to set.
        Returns:
        the Activity object itself.