SetVariableActivity Class

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

public class SetVariableActivity
extends ControlActivity

Set value for a Variable.

Constructor Summary

Constructor Description
SetVariableActivity()

Creates an instance of SetVariableActivity class.

Method Summary

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

Reads an instance of SetVariableActivity from the JsonReader.
SecureInputOutputPolicy getPolicy()

Get the policy property: Activity policy.
String getType()

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

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

Get the variableName property: Name of the variable whose value needs to be set.
Boolean isSetSystemVariable()

Get the setSystemVariable property: If set to true, it sets the pipeline run return value.
SetVariableActivity setDependsOn(List<ActivityDependency> dependsOn)

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

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

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

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
SetVariableActivity setPolicy(SecureInputOutputPolicy policy)

Set the policy property: Activity policy.
SetVariableActivity setSetSystemVariable(Boolean setSystemVariable)

Set the setSystemVariable property: If set to true, it sets the pipeline run return value.
SetVariableActivity setState(ActivityState state)

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

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

Set the value property: Value to be set.
SetVariableActivity setVariableName(String variableName)

Set the variableName property: Name of the variable whose value needs to be set.
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

SetVariableActivity

public SetVariableActivity()

Creates an instance of SetVariableActivity class.

Method Details

fromJson

public static SetVariableActivity fromJson(JsonReader jsonReader)

Reads an instance of SetVariableActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SetVariableActivity 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.

getPolicy

public SecureInputOutputPolicy getPolicy()

Get the policy property: Activity policy.

Returns:

the policy value.

getType

public String getType()

Get the type property: Type of activity.

Overrides:

SetVariableActivity.getType()

Returns:

the type value.

getValue

public Object getValue()

Get the value property: Value to be set. 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 set.

Returns:

the variableName value.

isSetSystemVariable

public Boolean isSetSystemVariable()

Get the setSystemVariable property: If set to true, it sets the pipeline run return value.

Returns:

the setSystemVariable value.

setDependsOn

public SetVariableActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

SetVariableActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public SetVariableActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

SetVariableActivity.setDescription(String description)

Parameters:

description

setName

public SetVariableActivity setName(String name)

Set the name property: Activity name.

Overrides:

SetVariableActivity.setName(String name)

Parameters:

name

setOnInactiveMarkAs

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

SetVariableActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setPolicy

public SetVariableActivity setPolicy(SecureInputOutputPolicy policy)

Set the policy property: Activity policy.

Parameters:

policy - the policy value to set.

Returns:

the SetVariableActivity object itself.

setSetSystemVariable

public SetVariableActivity setSetSystemVariable(Boolean setSystemVariable)

Set the setSystemVariable property: If set to true, it sets the pipeline run return value.

Parameters:

setSystemVariable - the setSystemVariable value to set.

Returns:

the SetVariableActivity object itself.

setState

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

SetVariableActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public SetVariableActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

SetVariableActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

setValue

public SetVariableActivity setValue(Object value)

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

Parameters:

value - the value value to set.

Returns:

the SetVariableActivity object itself.

setVariableName

public SetVariableActivity setVariableName(String variableName)

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

Parameters:

variableName - the variableName value to set.

Returns:

the SetVariableActivity object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SetVariableActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to