Package com.azure.analytics.synapse.artifacts.models

Class DatabricksNotebookActivity

java.lang.Object

com.azure.analytics.synapse.artifacts.models.Activity

com.azure.analytics.synapse.artifacts.models.ExecutionActivity

com.azure.analytics.synapse.artifacts.models.DatabricksNotebookActivity

public class DatabricksNotebookActivity
extends ExecutionActivity

DatabricksNotebook activity.

Constructor Summary

Constructors

Constructor	Description
DatabricksNotebookActivity()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getBaseParameters()	Get the baseParameters property: Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.
List<Map<String,Object>>	getLibraries()	Get the libraries property: A list of libraries to be installed on the cluster that will execute the job.
Object	getNotebookPath()	Get the notebookPath property: The absolute path of the notebook to be run in the Databricks Workspace.
DatabricksNotebookActivity	setBaseParameters(Map<String,Object> baseParameters)	Set the baseParameters property: Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.
DatabricksNotebookActivity	setDependsOn(List<ActivityDependency> dependsOn)	Set the dependsOn property: Activity depends on condition.
DatabricksNotebookActivity	setDescription(String description)	Set the description property: Activity description.
DatabricksNotebookActivity	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.
DatabricksNotebookActivity	setLinkedServiceName(LinkedServiceReference linkedServiceName)	Set the linkedServiceName property: Linked service reference.
DatabricksNotebookActivity	setName(String name)	Set the name property: Activity name.
DatabricksNotebookActivity	setNotebookPath(Object notebookPath)	Set the notebookPath property: The absolute path of the notebook to be run in the Databricks Workspace.
DatabricksNotebookActivity	setPolicy(ActivityPolicy policy)	Set the policy property: Activity policy.
DatabricksNotebookActivity	setUserProperties(List<UserProperty> userProperties)	Set the userProperties property: Activity user properties.

Methods inherited from class com.azure.analytics.synapse.artifacts.models.ExecutionActivity

getLinkedServiceName, getPolicy

Methods inherited from class com.azure.analytics.synapse.artifacts.models.Activity

getAdditionalProperties, getDependsOn, getDescription, getName, getUserProperties, setAdditionalProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabricksNotebookActivity

public DatabricksNotebookActivity()

Method Detail

getNotebookPath

public Object getNotebookPath()

Get the notebookPath property: The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

Returns:

the notebookPath value.

setNotebookPath

public DatabricksNotebookActivity setNotebookPath(Object notebookPath)

Set the notebookPath property: The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

Parameters:

notebookPath - the notebookPath value to set.

Returns:

the DatabricksNotebookActivity object itself.

getBaseParameters

public Map<String,Object> getBaseParameters()

Get the baseParameters property: Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.

Returns:

the baseParameters value.

setBaseParameters

public DatabricksNotebookActivity setBaseParameters(Map<String,Object> baseParameters)

Set the baseParameters property: Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.

Parameters:

baseParameters - the baseParameters value to set.

Returns:

the DatabricksNotebookActivity object itself.

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.

setLibraries

public DatabricksNotebookActivity 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 DatabricksNotebookActivity object itself.

setLinkedServiceName

public DatabricksNotebookActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

setLinkedServiceName in class ExecutionActivity

Parameters:

linkedServiceName - the linkedServiceName value to set.

Returns:

the ExecutionActivity object itself.

setPolicy

public DatabricksNotebookActivity setPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

setPolicy in class ExecutionActivity

Parameters:

policy - the policy value to set.

Returns:

the ExecutionActivity object itself.

setName

public DatabricksNotebookActivity setName(String name)

Set the name property: Activity name.

Overrides:

setName in class ExecutionActivity

Parameters:

name - the name value to set.

Returns:

the Activity object itself.

setDescription

public DatabricksNotebookActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

setDescription in class ExecutionActivity

Parameters:

description - the description value to set.

Returns:

the Activity object itself.

setDependsOn

public DatabricksNotebookActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

setDependsOn in class ExecutionActivity

Parameters:

dependsOn - the dependsOn value to set.

Returns:

the Activity object itself.

setUserProperties

public DatabricksNotebookActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

setUserProperties in class ExecutionActivity

Parameters:

userProperties - the userProperties value to set.

Returns:

the Activity object itself.