DatabricksNotebookActivity Class
- java.
lang. Object - com.
azure. analytics. synapse. artifacts. models. Activity - com.
azure. analytics. synapse. artifacts. models. ExecutionActivity - com.
azure. analytics. synapse. artifacts. models. DatabricksNotebookActivity
- com.
- com.
- com.
public class DatabricksNotebookActivity
extends ExecutionActivity
DatabricksNotebook activity.
Constructor Summary
Constructor | Description |
---|---|
DatabricksNotebookActivity() |
Creates an instance of Databricks |
Method Summary
Modifier and Type | Method and Description |
---|---|
Map<String,Object> |
getBaseParameters()
Get the base |
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 notebook |
Databricks |
setBaseParameters(Map<String,Object> baseParameters)
Set the base |
Databricks |
setDependsOn(List<ActivityDependency> dependsOn)
Set the depends |
Databricks |
setDescription(String description)
Set the description property: Activity description. |
Databricks |
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. |
Databricks |
setLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linked |
Databricks |
setName(String name)
Set the name property: Activity name. |
Databricks |
setNotebookPath(Object notebookPath)
Set the notebook |
Databricks |
setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)
Set the on |
Databricks |
setPolicy(ActivityPolicy policy)
Set the policy property: Activity policy. |
Databricks |
setState(ActivityState state)
Set the state property: Activity state. |
Databricks |
setUserProperties(List<UserProperty> userProperties)
Set the user |
Methods inherited from Activity
Methods inherited from ExecutionActivity
Methods inherited from java.lang.Object
Constructor Details
DatabricksNotebookActivity
public DatabricksNotebookActivity()
Creates an instance of DatabricksNotebookActivity class.
Method Details
getBaseParameters
public Map
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:
getLibraries
public List<>
Get the libraries property: A list of libraries to be installed on the cluster that will execute the job.
Returns:
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:
setBaseParameters
public DatabricksNotebookActivity setBaseParameters(Map
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:
Returns:
setDependsOn
public DatabricksNotebookActivity setDependsOn(List
Set the dependsOn property: Activity depends on condition.
Overrides:
DatabricksNotebookActivity.setDependsOn(List<ActivityDependency> dependsOn)Parameters:
setDescription
public DatabricksNotebookActivity setDescription(String description)
Set the description property: Activity description.
Overrides:
DatabricksNotebookActivity.setDescription(String description)Parameters:
setLibraries
public DatabricksNotebookActivity setLibraries(List<>
Set the libraries property: A list of libraries to be installed on the cluster that will execute the job.
Parameters:
Returns:
setLinkedServiceName
public DatabricksNotebookActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linkedServiceName property: Linked service reference.
Overrides:
DatabricksNotebookActivity.setLinkedServiceName(LinkedServiceReference linkedServiceName)Parameters:
setName
public DatabricksNotebookActivity setName(String name)
Set the name property: Activity name.
Overrides:
DatabricksNotebookActivity.setName(String name)Parameters:
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:
Returns:
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:
setPolicy
public DatabricksNotebookActivity setPolicy(ActivityPolicy policy)
Set the policy property: Activity policy.
Overrides:
DatabricksNotebookActivity.setPolicy(ActivityPolicy policy)Parameters:
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:
setUserProperties
public DatabricksNotebookActivity setUserProperties(List
Set the userProperties property: Activity user properties.
Overrides:
DatabricksNotebookActivity.setUserProperties(List<UserProperty> userProperties)Parameters:
Applies to
Azure SDK for Java
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for