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

Class IfConditionActivity

java.lang.Object

com.azure.analytics.synapse.artifacts.models.Activity

com.azure.analytics.synapse.artifacts.models.ControlActivity

com.azure.analytics.synapse.artifacts.models.IfConditionActivity

public class IfConditionActivity
extends ControlActivity

This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.

Constructor Summary

Constructors

Constructor	Description
IfConditionActivity()

Method Summary

Modifier and Type	Method	Description
Expression	getExpression()	Get the expression property: An expression that would evaluate to Boolean.
List<Activity>	getIfFalseActivities()	Get the ifFalseActivities property: List of activities to execute if expression is evaluated to false.
List<Activity>	getIfTrueActivities()	Get the ifTrueActivities property: List of activities to execute if expression is evaluated to true.
IfConditionActivity	setDependsOn(List<ActivityDependency> dependsOn)	Set the dependsOn property: Activity depends on condition.
IfConditionActivity	setDescription(String description)	Set the description property: Activity description.
IfConditionActivity	setExpression(Expression expression)	Set the expression property: An expression that would evaluate to Boolean.
IfConditionActivity	setIfFalseActivities(List<Activity> ifFalseActivities)	Set the ifFalseActivities property: List of activities to execute if expression is evaluated to false.
IfConditionActivity	setIfTrueActivities(List<Activity> ifTrueActivities)	Set the ifTrueActivities property: List of activities to execute if expression is evaluated to true.
IfConditionActivity	setName(String name)	Set the name property: Activity name.
IfConditionActivity	setUserProperties(List<UserProperty> userProperties)	Set the userProperties property: Activity user properties.

Methods inherited from class com.azure.analytics.synapse.artifacts.models.Activity

getAdditionalProperties, getDependsOn, getDescription, getName, getUserProperties, setAdditionalProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IfConditionActivity

public IfConditionActivity()

Method Detail

getExpression

public Expression getExpression()

Get the expression property: An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.

Returns:

the expression value.

setExpression

public IfConditionActivity setExpression(Expression expression)

Set the expression property: An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.

Parameters:

expression - the expression value to set.

Returns:

the IfConditionActivity object itself.

getIfTrueActivities

public List<Activity> getIfTrueActivities()

Get the ifTrueActivities property: List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.

Returns:

the ifTrueActivities value.

setIfTrueActivities

public IfConditionActivity setIfTrueActivities(List<Activity> ifTrueActivities)

Set the ifTrueActivities property: List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.

Parameters:

ifTrueActivities - the ifTrueActivities value to set.

Returns:

the IfConditionActivity object itself.

getIfFalseActivities

public List<Activity> getIfFalseActivities()

Get the ifFalseActivities property: List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.

Returns:

the ifFalseActivities value.

setIfFalseActivities

public IfConditionActivity setIfFalseActivities(List<Activity> ifFalseActivities)

Set the ifFalseActivities property: List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.

Parameters:

ifFalseActivities - the ifFalseActivities value to set.

Returns:

the IfConditionActivity object itself.

setName

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