SetVariableActivity Class

Package:
com.azure.resourcemanager.datafactory.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

public final 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 policy()

Get the policy property: Activity policy.
Boolean setSystemVariable()

Get the setSystemVariable property: If set to true, it sets the pipeline run return value.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Type of activity.
void validate()

Validates the instance.
Object value()

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

Get the variableName property: Name of the variable whose value needs to be set.
SetVariableActivity withDependsOn(List<ActivityDependency> dependsOn)

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

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

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

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

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

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

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

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

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

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

Methods inherited from Activity

additionalProperties dependsOn description name onInactiveMarkAs state userProperties withAdditionalProperties

Methods inherited from ControlActivity

fromJson toJson type validate withDependsOn withDescription withName withOnInactiveMarkAs withState withUserProperties

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.

policy

public SecureInputOutputPolicy policy()

Get the policy property: Activity policy.

Returns:

the policy value.

setSystemVariable

public Boolean setSystemVariable()

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

Returns:

the setSystemVariable value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SetVariableActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Type of activity.

Overrides:

SetVariableActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

SetVariableActivity.validate()

value

public Object value()

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

Returns:

the value value.

variableName

public String variableName()

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

Returns:

the variableName value.

withDependsOn

public SetVariableActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

SetVariableActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public SetVariableActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

SetVariableActivity.withDescription(String description)

Parameters:

description

withName

public SetVariableActivity withName(String name)

Set the name property: Activity name.

Overrides:

SetVariableActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

public SetVariableActivity withOnInactiveMarkAs(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.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withPolicy

public SetVariableActivity withPolicy(SecureInputOutputPolicy policy)

Set the policy property: Activity policy.

Parameters:

policy - the policy value to set.

Returns:

the SetVariableActivity object itself.

withSetSystemVariable

public SetVariableActivity withSetSystemVariable(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.

withState

public SetVariableActivity withState(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.withState(ActivityState state)

Parameters:

state

withUserProperties

public SetVariableActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

SetVariableActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

withValue

public SetVariableActivity withValue(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.

withVariableName

public SetVariableActivity withVariableName(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.

Applies to