AppendVariableActivity Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public class AppendVariableActivity
extends ControlActivity

Append value for a Variable of type Array.

Constructor Summary

Constructor Description
AppendVariableActivity()

Creates an instance of AppendVariableActivity class.

Method Summary

Modifier and Type Method and Description
static AppendVariableActivity fromJson(JsonReader jsonReader)

Reads an instance of AppendVariableActivity from the JsonReader.
String getType()

Get the type property: Type of activity.
Object getValue()

Get the value property: Value to be appended.
String getVariableName()

Get the variableName property: Name of the variable whose value needs to be appended to.
AppendVariableActivity setDependsOn(List<ActivityDependency> dependsOn)

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

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

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

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

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

Set the userProperties property: Activity user properties.
AppendVariableActivity setValue(Object value)

Set the value property: Value to be appended.
AppendVariableActivity setVariableName(String variableName)

Set the variableName property: Name of the variable whose value needs to be appended to.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from Activity

getAdditionalProperties getDependsOn getDescription getName getOnInactiveMarkAs getState getUserProperties setAdditionalProperties

Methods inherited from ControlActivity

fromJson getType setDependsOn setDescription setName setOnInactiveMarkAs setState setUserProperties toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AppendVariableActivity

public AppendVariableActivity()

Creates an instance of AppendVariableActivity class.

Method Details

fromJson

public static AppendVariableActivity fromJson(JsonReader jsonReader)

Reads an instance of AppendVariableActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AppendVariableActivity if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getType

public String getType()

Get the type property: Type of activity.

Overrides:

AppendVariableActivity.getType()

Returns:

the type value.

getValue

public Object getValue()

Get the value property: Value to be appended. Could be a static value or Expression.

Returns:

the value value.

getVariableName

public String getVariableName()

Get the variableName property: Name of the variable whose value needs to be appended to.

Returns:

the variableName value.

setDependsOn

public AppendVariableActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

AppendVariableActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public AppendVariableActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

AppendVariableActivity.setDescription(String description)

Parameters:

description

setName

public AppendVariableActivity setName(String name)

Set the name property: Activity name.

Overrides:

AppendVariableActivity.setName(String name)

Parameters:

name

setOnInactiveMarkAs

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

AppendVariableActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setState

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

AppendVariableActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public AppendVariableActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

AppendVariableActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

setValue

public AppendVariableActivity setValue(Object value)

Set the value property: Value to be appended. Could be a static value or Expression.

Parameters:

value - the value value to set.

Returns:

the AppendVariableActivity object itself.

setVariableName

public AppendVariableActivity setVariableName(String variableName)

Set the variableName property: Name of the variable whose value needs to be appended to.

Parameters:

variableName - the variableName value to set.

Returns:

the AppendVariableActivity object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AppendVariableActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to