ControlActivity Class

  • Reference
Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

public class ControlActivity
extends Activity

Base class for all control activities like IfCondition, ForEach , Until.

Constructor Summary

Constructor Description
ControlActivity()

Creates an instance of ControlActivity class.

Method Summary

Modifier and Type Method and Description
ControlActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.
ControlActivity setDescription(String description)

Set the description property: Activity description.
ControlActivity setName(String name)

Set the name property: Activity name.
ControlActivity setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
ControlActivity setState(ActivityState state)

Set the state property: Activity state.
ControlActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Methods inherited from Activity

getAdditionalProperties getDependsOn getDescription getName getOnInactiveMarkAs getState getUserProperties setAdditionalProperties 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

ControlActivity

public ControlActivity()

Creates an instance of ControlActivity class.

Method Details

setDependsOn

public ControlActivity setDependsOn(List dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

ControlActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public ControlActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

ControlActivity.setDescription(String description)

Parameters:

description

setName

public ControlActivity setName(String name)

Set the name property: Activity name.

Overrides:

ControlActivity.setName(String name)

Parameters:

name

setOnInactiveMarkAs

public ControlActivity 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:

ControlActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setState

public ControlActivity 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:

ControlActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public ControlActivity setUserProperties(List userProperties)

Set the userProperties property: Activity user properties.

Overrides:

ControlActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

Applies to