ExecutionActivity Class

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

public class ExecutionActivity
extends Activity

Base class for all execution activities.

Constructor Summary

Constructor Description
ExecutionActivity()

Creates an instance of ExecutionActivity class.

Method Summary

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

Reads an instance of ExecutionActivity from the JsonReader.
LinkedServiceReference getLinkedServiceName()

Get the linkedServiceName property: Linked service reference.
ActivityPolicy getPolicy()

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

Get the type property: Type of activity.
ExecutionActivity setDependsOn(List<ActivityDependency> dependsOn)

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

Set the description property: Activity description.
ExecutionActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.
ExecutionActivity setName(String name)

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

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

Set the policy property: Activity policy.
ExecutionActivity setState(ActivityState state)

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

Set the userProperties property: Activity user properties.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from Activity

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

ExecutionActivity

public ExecutionActivity()

Creates an instance of ExecutionActivity class.

Method Details

fromJson

public static ExecutionActivity fromJson(JsonReader jsonReader)

Reads an instance of ExecutionActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getLinkedServiceName

public LinkedServiceReference getLinkedServiceName()

Get the linkedServiceName property: Linked service reference.

Returns:

the linkedServiceName value.

getPolicy

public ActivityPolicy getPolicy()

Get the policy property: Activity policy.

Returns:

the policy value.

getType

public String getType()

Get the type property: Type of activity.

Overrides:

ExecutionActivity.getType()

Returns:

the type value.

setDependsOn

public ExecutionActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

ExecutionActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public ExecutionActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

ExecutionActivity.setDescription(String description)

Parameters:

description

setLinkedServiceName

public ExecutionActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Parameters:

linkedServiceName - the linkedServiceName value to set.

Returns:

the ExecutionActivity object itself.

setName

public ExecutionActivity setName(String name)

Set the name property: Activity name.

Overrides:

ExecutionActivity.setName(String name)

Parameters:

name

setOnInactiveMarkAs

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

ExecutionActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setPolicy

public ExecutionActivity setPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Parameters:

policy - the policy value to set.

Returns:

the ExecutionActivity object itself.

setState

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

ExecutionActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public ExecutionActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

ExecutionActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ExecutionActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to