IfConditionActivity Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
IfConditionActivity.cs

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.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.IfConditionActivity+IfConditionActivityConverter))]
public class IfConditionActivity : Azure.Analytics.Synapse.Artifacts.Models.ControlActivity
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.IfConditionActivity+IfConditionActivityConverter))>]
type IfConditionActivity = class
    inherit ControlActivity
Public Class IfConditionActivity
Inherits ControlActivity
Inheritance
Object
Activity
ControlActivity
IfConditionActivity
Attributes
JsonConverterAttribute

Constructors

IfConditionActivity(String, Expression)

Initializes a new instance of IfConditionActivity.

Properties

AdditionalProperties

Additional Properties.

(Inherited from Activity)
DependsOn

Activity depends on condition.

(Inherited from Activity)
Description

Activity description.

(Inherited from Activity)
Expression

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

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. Please note Activity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AppendVariableActivity, AzureDataExplorerCommandActivity, AzureFunctionActivity, AzureMLBatchExecutionActivity, AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, ControlActivity, CopyActivity, CustomActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DataLakeAnalyticsUsqlActivity, DeleteActivity, ExecuteDataFlowActivity, ExecutePipelineActivity, ExecuteSsisPackageActivity, ExecutionActivity, FailActivity, FilterActivity, ForEachActivity, GetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, IfConditionActivity, LookupActivity, ScriptActivity, SetVariableActivity, SynapseSparkJobDefinitionActivity, SqlPoolStoredProcedureActivity, SqlServerStoredProcedureActivity, SwitchActivity, SynapseNotebookActivity, UntilActivity, ValidationActivity, WaitActivity, WebActivity and WebHookActivity.
IfTrueActivities

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. Please note Activity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AppendVariableActivity, AzureDataExplorerCommandActivity, AzureFunctionActivity, AzureMLBatchExecutionActivity, AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, ControlActivity, CopyActivity, CustomActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DataLakeAnalyticsUsqlActivity, DeleteActivity, ExecuteDataFlowActivity, ExecutePipelineActivity, ExecuteSsisPackageActivity, ExecutionActivity, FailActivity, FilterActivity, ForEachActivity, GetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, IfConditionActivity, LookupActivity, ScriptActivity, SetVariableActivity, SynapseSparkJobDefinitionActivity, SqlPoolStoredProcedureActivity, SqlServerStoredProcedureActivity, SwitchActivity, SynapseNotebookActivity, UntilActivity, ValidationActivity, WaitActivity, WebActivity and WebHookActivity.
Name

Activity name.

(Inherited from Activity)
OnInactiveMarkAs

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.

(Inherited from Activity)
State

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

(Inherited from Activity)
UserProperties

Activity user properties.

(Inherited from Activity)

Applies to