Share via

SwitchActivity 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:
SwitchActivity.cs

This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

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

Constructors

SwitchActivity(String, Expression)

Initializes a new instance of SwitchActivity.

Properties

AdditionalProperties

Additional Properties.

(Inherited from Activity)
Cases

List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.
DefaultActivities

List of activities to execute if no case condition is satisfied. 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.
DependsOn

Activity depends on condition.

(Inherited from Activity)
Description

Activity description.

(Inherited from Activity)
Name

Activity name.

(Inherited from Activity)
On

An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.
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