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

Class SynapseNotebookActivity

java.lang.Object

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

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

com.azure.analytics.synapse.artifacts.models.SynapseNotebookActivity

public class SynapseNotebookActivity
extends ExecutionActivity

Execute Synapse notebook activity.

Constructor Summary

Constructors

Constructor	Description
SynapseNotebookActivity()

Method Summary

Modifier and Type	Method	Description
SynapseNotebookReference	getNotebook()	Get the notebook property: Synapse notebook reference.
Map<String,NotebookParameter>	getParameters()	Get the parameters property: Notebook parameters.
BigDataPoolParametrizationReference	getSparkPool()	Get the sparkPool property: The name of the big data pool which will be used to execute the notebook.
SynapseNotebookActivity	setDependsOn(List<ActivityDependency> dependsOn)	Set the dependsOn property: Activity depends on condition.
SynapseNotebookActivity	setDescription(String description)	Set the description property: Activity description.
SynapseNotebookActivity	setLinkedServiceName(LinkedServiceReference linkedServiceName)	Set the linkedServiceName property: Linked service reference.
SynapseNotebookActivity	setName(String name)	Set the name property: Activity name.
SynapseNotebookActivity	setNotebook(SynapseNotebookReference notebook)	Set the notebook property: Synapse notebook reference.
SynapseNotebookActivity	setParameters(Map<String,NotebookParameter> parameters)	Set the parameters property: Notebook parameters.
SynapseNotebookActivity	setPolicy(ActivityPolicy policy)	Set the policy property: Activity policy.
SynapseNotebookActivity	setSparkPool(BigDataPoolParametrizationReference sparkPool)	Set the sparkPool property: The name of the big data pool which will be used to execute the notebook.
SynapseNotebookActivity	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 Details

SynapseNotebookActivity

public SynapseNotebookActivity()

Method Details

getNotebook

public SynapseNotebookReference getNotebook()

Get the notebook property: Synapse notebook reference.

Returns:

the notebook value.

setNotebook

public SynapseNotebookActivity setNotebook(SynapseNotebookReference notebook)

Set the notebook property: Synapse notebook reference.

Parameters:

notebook - the notebook value to set.

Returns:

the SynapseNotebookActivity object itself.

getSparkPool

public BigDataPoolParametrizationReference getSparkPool()

Get the sparkPool property: The name of the big data pool which will be used to execute the notebook.

Returns:

the sparkPool value.

setSparkPool

public SynapseNotebookActivity setSparkPool(BigDataPoolParametrizationReference sparkPool)

Set the sparkPool property: The name of the big data pool which will be used to execute the notebook.

Parameters:

sparkPool - the sparkPool value to set.

Returns:

the SynapseNotebookActivity object itself.

getParameters

public Map<String,NotebookParameter> getParameters()

Get the parameters property: Notebook parameters.

Returns:

the parameters value.

setParameters

public SynapseNotebookActivity setParameters(Map<String,NotebookParameter> parameters)

Set the parameters property: Notebook parameters.

Parameters:

parameters - the parameters value to set.

Returns:

the SynapseNotebookActivity object itself.

setLinkedServiceName

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