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

Class UntilActivity

  • public class UntilActivity
extends ControlActivity
    This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.

    • Constructor Detail

      • UntilActivity

        public UntilActivity()

    • Method Detail

      • getExpression

        public Expression getExpression()
        Get the expression property: An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.
        Returns:
        the expression value.

      • setExpression

        public UntilActivity setExpression​(Expression expression)
        Set the expression property: An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.
        Parameters:
        expression - the expression value to set.
        Returns:
        the UntilActivity object itself.

      • getTimeout

        public Object getTimeout()
        Get the timeout property: Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Returns:
        the timeout value.

      • setTimeout

        public UntilActivity setTimeout​(Object timeout)
        Set the timeout property: Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Parameters:
        timeout - the timeout value to set.
        Returns:
        the UntilActivity object itself.

      • getActivities

        public List<Activity> getActivities()
        Get the activities property: List of activities to execute.
        Returns:
        the activities value.

      • setActivities

        public UntilActivity setActivities​(List<Activity> activities)
        Set the activities property: List of activities to execute.
        Parameters:
        activities - the activities value to set.
        Returns:
        the UntilActivity object itself.

      • setName

        public UntilActivity 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 UntilActivity 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 UntilActivity 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.