Activity 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

public class Activity

A pipeline activity.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getAdditionalProperties() Get the additionalProperties property: A pipeline activity.
List<ActivityDependency>	getDependsOn() Get the dependsOn property: Activity depends on condition.
String	getDescription() Get the description property: Activity description.
String	getName() Get the name property: Activity name.
ActivityOnInactiveMarkAs	getOnInactiveMarkAs() Get the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
ActivityState	getState() Get the state property: Activity state.
List<UserProperty>	getUserProperties() Get the userProperties property: Activity user properties.
Activity	setAdditionalProperties(Map<String,Object> additionalProperties) Set the additionalProperties property: A pipeline activity.
Activity	setDependsOn(List<ActivityDependency> dependsOn) Set the dependsOn property: Activity depends on condition.
Activity	setDescription(String description) Set the description property: Activity description.
Activity	setName(String name) Set the name property: Activity name.
Activity	setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs) Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
Activity	setState(ActivityState state) Set the state property: Activity state.
Activity	setUserProperties(List<UserProperty> userProperties) Set the userProperties property: Activity user properties.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Activity

public Activity()

Creates an instance of Activity class.

Method Details

getAdditionalProperties

public Map getAdditionalProperties()

Get the additionalProperties property: A pipeline activity.

Returns:

the additionalProperties value.

getDependsOn

public List getDependsOn()

Get the dependsOn property: Activity depends on condition.

Returns:

the dependsOn value.

getDescription

public String getDescription()

Get the description property: Activity description.

Returns:

the description value.

getName

public String getName()

Get the name property: Activity name.

Returns:

the name value.

getOnInactiveMarkAs

public ActivityOnInactiveMarkAs getOnInactiveMarkAs()

Get 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.

Returns:

the onInactiveMarkAs value.

getState

public ActivityState getState()

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

Returns:

the state value.

getUserProperties

public List getUserProperties()

Get the userProperties property: Activity user properties.

Returns:

the userProperties value.

setAdditionalProperties

public Activity setAdditionalProperties(Map additionalProperties)

Set the additionalProperties property: A pipeline activity.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the Activity object itself.

setDependsOn

public Activity setDependsOn(List dependsOn)

Set the dependsOn property: Activity depends on condition.

Parameters:

dependsOn - the dependsOn value to set.

Returns:

the Activity object itself.

setDescription

public Activity setDescription(String description)

Set the description property: Activity description.

Parameters:

description - the description value to set.

Returns:

the Activity object itself.

setName

public Activity setName(String name)

Set the name property: Activity name.

Parameters:

name - the name value to set.

Returns:

the Activity object itself.

setOnInactiveMarkAs

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

Parameters:

onInactiveMarkAs - the onInactiveMarkAs value to set.

Returns:

the Activity object itself.

setState

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

Parameters:

state - the state value to set.

Returns:

the Activity object itself.

setUserProperties

public Activity setUserProperties(List userProperties)

Set the userProperties property: Activity user properties.

Parameters:

userProperties - the userProperties value to set.

Returns:

the Activity object itself.