DatabricksSparkPythonActivity Class

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

public class DatabricksSparkPythonActivity
extends ExecutionActivity

DatabricksSparkPython activity.

Constructor Summary

Constructor Description
DatabricksSparkPythonActivity()

Creates an instance of DatabricksSparkPythonActivity class.

Method Summary

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

Reads an instance of DatabricksSparkPythonActivity from the JsonReader.
List<Map<String,Object>> getLibraries()

Get the libraries property: A list of libraries to be installed on the cluster that will execute the job.
List<Object> getParameters()

Get the parameters property: Command line parameters that will be passed to the Python file.
Object getPythonFile()

Get the pythonFile property: The URI of the Python file to be executed.
String getType()

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

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

Set the description property: Activity description.
DatabricksSparkPythonActivity setLibraries(List<Map<String,Object>> libraries)

Set the libraries property: A list of libraries to be installed on the cluster that will execute the job.
DatabricksSparkPythonActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)

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

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

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
DatabricksSparkPythonActivity setParameters(List<Object> parameters)

Set the parameters property: Command line parameters that will be passed to the Python file.
DatabricksSparkPythonActivity setPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.
DatabricksSparkPythonActivity setPythonFile(Object pythonFile)

Set the pythonFile property: The URI of the Python file to be executed.
DatabricksSparkPythonActivity setState(ActivityState state)

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

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

Methods inherited from Activity

getAdditionalProperties getDependsOn getDescription getName getOnInactiveMarkAs getState getUserProperties setAdditionalProperties

Methods inherited from ExecutionActivity

fromJson getLinkedServiceName getPolicy getType setDependsOn setDescription setLinkedServiceName setName setOnInactiveMarkAs setPolicy setState setUserProperties toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DatabricksSparkPythonActivity

public DatabricksSparkPythonActivity()

Creates an instance of DatabricksSparkPythonActivity class.

Method Details

fromJson

public static DatabricksSparkPythonActivity fromJson(JsonReader jsonReader)

Reads an instance of DatabricksSparkPythonActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getLibraries

public List<Map<String,Object>> getLibraries()

Get the libraries property: A list of libraries to be installed on the cluster that will execute the job.

Returns:

the libraries value.

getParameters

public List<Object> getParameters()

Get the parameters property: Command line parameters that will be passed to the Python file.

Returns:

the parameters value.

getPythonFile

public Object getPythonFile()

Get the pythonFile property: The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string).

Returns:

the pythonFile value.

getType

public String getType()

Get the type property: Type of activity.

Overrides:

DatabricksSparkPythonActivity.getType()

Returns:

the type value.

setDependsOn

public DatabricksSparkPythonActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

DatabricksSparkPythonActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public DatabricksSparkPythonActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

DatabricksSparkPythonActivity.setDescription(String description)

Parameters:

description

setLibraries

public DatabricksSparkPythonActivity setLibraries(List<Map<String,Object>> libraries)

Set the libraries property: A list of libraries to be installed on the cluster that will execute the job.

Parameters:

libraries - the libraries value to set.

Returns:

the DatabricksSparkPythonActivity object itself.

setLinkedServiceName

public DatabricksSparkPythonActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

DatabricksSparkPythonActivity.setLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

setName

public DatabricksSparkPythonActivity setName(String name)

Set the name property: Activity name.

Overrides:

DatabricksSparkPythonActivity.setName(String name)

Parameters:

name

setOnInactiveMarkAs

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

DatabricksSparkPythonActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setParameters

public DatabricksSparkPythonActivity setParameters(List<Object> parameters)

Set the parameters property: Command line parameters that will be passed to the Python file.

Parameters:

parameters - the parameters value to set.

Returns:

the DatabricksSparkPythonActivity object itself.

setPolicy

public DatabricksSparkPythonActivity setPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

DatabricksSparkPythonActivity.setPolicy(ActivityPolicy policy)

Parameters:

policy

setPythonFile

public DatabricksSparkPythonActivity setPythonFile(Object pythonFile)

Set the pythonFile property: The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string).

Parameters:

pythonFile - the pythonFile value to set.

Returns:

the DatabricksSparkPythonActivity object itself.

setState

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

DatabricksSparkPythonActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public DatabricksSparkPythonActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

DatabricksSparkPythonActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DatabricksSparkPythonActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to