ForEachActivity Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

• 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 Summary

Constructor	Description
ForEachActivity()	Creates an instance of ForEachActivity class.

Method Summary

Modifier and Type	Method and Description
List<Activity>	getActivities() Get the activities property: List of activities to execute .
Integer	getBatchCount() Get the batchCount property: Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).
Expression	getItems() Get the items property: Collection to iterate.
Boolean	isSequential() Get the isSequential property: Should the loop be executed in sequence or in parallel (max 50).
ForEachActivity	setActivities(List<Activity> activities) Set the activities property: List of activities to execute .
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).
ForEachActivity	setDependsOn(List<ActivityDependency> dependsOn) Set the dependsOn property: Activity depends on condition.
ForEachActivity	setDescription(String description) Set the description property: Activity description.
ForEachActivity	setIsSequential(Boolean isSequential) Set the isSequential property: Should the loop be executed in sequence or in parallel (max 50).
ForEachActivity	setItems(Expression items) Set the items property: Collection to iterate.
ForEachActivity	setName(String name) Set the name property: Activity name.
ForEachActivity	setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs) Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
ForEachActivity	setState(ActivityState state) Set the state property: Activity state.
ForEachActivity	setUserProperties(List<UserProperty> userProperties) Set the userProperties property: Activity user properties.

Methods inherited from Activity

getAdditionalProperties getDependsOn getDescription getName getOnInactiveMarkAs getState getUserProperties setAdditionalProperties

Methods inherited from ControlActivity

setDependsOn setDescription setName setOnInactiveMarkAs setState setUserProperties

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ForEachActivity

public ForEachActivity()

Creates an instance of ForEachActivity class.

Method Details

getActivities

public List getActivities()

Get the activities property: List of activities to execute .

Returns:

the activities value.

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.

getItems

public Expression getItems()

Get the items property: Collection to iterate.

Returns:

the items value.

isSequential

public Boolean isSequential()

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

Returns:

the isSequential value.

setActivities

public ForEachActivity setActivities(List activities)

Set the activities property: List of activities to execute .

Parameters:

activities - the activities value to set.

Returns:

the ForEachActivity object itself.

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.

setDependsOn

public ForEachActivity setDependsOn(List dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

ForEachActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public ForEachActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

ForEachActivity.setDescription(String description)

Parameters:

description

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.

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.

setName

public ForEachActivity setName(String name)

Set the name property: Activity name.

Overrides:

ForEachActivity.setName(String name)

Parameters:

name

setOnInactiveMarkAs

public ForEachActivity setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

Overrides:

ForEachActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setState

public ForEachActivity setState(ActivityState state)

Set the state property: Activity state. This is an optional property and if not provided, the state will be Active by default.

Overrides:

ForEachActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public ForEachActivity setUserProperties(List userProperties)

Set the userProperties property: Activity user properties.

Overrides:

ForEachActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties