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

Class ForEachActivity

java.lang.Object
com.azure.analytics.synapse.artifacts.models.Activity
com.azure.analytics.synapse.artifacts.models.ControlActivity
com.azure.analytics.synapse.artifacts.models.ForEachActivity
public class ForEachActivity extends ControlActivity
This activity is used for iterating over a collection and execute given activities.

  • Constructor Details

    • ForEachActivity

      public ForEachActivity()

  • Method Details

    • isSequential

      public Boolean isSequential()
      Get the isSequential property: Should the loop be executed in sequence or in parallel (max 50).
      Returns:
      the isSequential value.

    • setIsSequential

      public ForEachActivity setIsSequential(Boolean isSequential)
      Set the isSequential property: Should the loop be executed in sequence or in parallel (max 50).
      Parameters:
      isSequential - the isSequential value to set.
      Returns:
      the ForEachActivity object itself.

    • getBatchCount

      public Integer getBatchCount()
      Get the batchCount property: Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).
      Returns:
      the batchCount value.

    • setBatchCount

      public ForEachActivity setBatchCount(Integer batchCount)
      Set the batchCount property: Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).
      Parameters:
      batchCount - the batchCount value to set.
      Returns:
      the ForEachActivity object itself.

    • getItems

      public Expression getItems()
      Get the items property: Collection to iterate.
      Returns:
      the items value.

    • setItems

      public ForEachActivity setItems(Expression items)
      Set the items property: Collection to iterate.
      Parameters:
      items - the items value to set.
      Returns:
      the ForEachActivity object itself.

    • getActivities

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

    • setActivities

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

    • setName

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

    • setDependsOn

      public ForEachActivity setDependsOn(List<ActivityDependency> dependsOn)
      Set the dependsOn property: Activity depends on condition.
      Overrides:
      setDependsOn in class ControlActivity
      Parameters:
      dependsOn - the dependsOn value to set.
      Returns:
      the Activity object itself.

    • setUserProperties

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