DatabricksNotebookActivity Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

• 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

Constructor	Description
DatabricksNotebookActivity()	Creates an instance of DatabricksNotebookActivity class.

Method Summary

Modifier and Type	Method and 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	setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs) Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
DatabricksNotebookActivity	setPolicy(ActivityPolicy policy) Set the policy property: Activity policy.
DatabricksNotebookActivity	setState(ActivityState state) Set the state property: Activity state.
DatabricksNotebookActivity	setUserProperties(List<UserProperty> userProperties) Set the userProperties property: Activity user properties.

Methods inherited from Activity

getAdditionalProperties getDependsOn getDescription getName getOnInactiveMarkAs getState getUserProperties setAdditionalProperties

Methods inherited from ExecutionActivity

getLinkedServiceName getPolicy setDependsOn setDescription setLinkedServiceName setName setOnInactiveMarkAs setPolicy setState setUserProperties

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DatabricksNotebookActivity

public DatabricksNotebookActivity()

Creates an instance of DatabricksNotebookActivity class.

Method Details

getBaseParameters

public Map 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.

getLibraries

public List<>> getLibraries()

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

Returns:

the libraries value.

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.

setBaseParameters

public DatabricksNotebookActivity setBaseParameters(Map 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.

setDependsOn

public DatabricksNotebookActivity setDependsOn(List dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

DatabricksNotebookActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public DatabricksNotebookActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

DatabricksNotebookActivity.setDescription(String description)

Parameters:

description

setLibraries

public DatabricksNotebookActivity setLibraries(List<>> 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:

DatabricksNotebookActivity.setLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

setName

public DatabricksNotebookActivity setName(String name)

Set the name property: Activity name.

Overrides:

DatabricksNotebookActivity.setName(String name)

Parameters:

name

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.

setOnInactiveMarkAs

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

DatabricksNotebookActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setPolicy

public DatabricksNotebookActivity setPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

DatabricksNotebookActivity.setPolicy(ActivityPolicy policy)

Parameters:

policy

setState

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

DatabricksNotebookActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public DatabricksNotebookActivity setUserProperties(List userProperties)

Set the userProperties property: Activity user properties.

Overrides:

DatabricksNotebookActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties