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

    • getExecutorSize

      public Object getExecutorSize()
      Get the executorSize property: Number of core and memory to be used for executors allocated in the specified Spark pool for the session, which will be used for overriding 'executorCores' and 'executorMemory' of the notebook you provide. Type: string (or Expression with resultType string).
      Returns:
      the executorSize value.

    • setExecutorSize

      public SynapseNotebookActivity setExecutorSize(Object executorSize)
      Set the executorSize property: Number of core and memory to be used for executors allocated in the specified Spark pool for the session, which will be used for overriding 'executorCores' and 'executorMemory' of the notebook you provide. Type: string (or Expression with resultType string).
      Parameters:
      executorSize - the executorSize value to set.
      Returns:
      the SynapseNotebookActivity object itself.

    • getConf

      public Object getConf()
      Get the conf property: Spark configuration properties, which will override the 'conf' of the notebook you provide.
      Returns:
      the conf value.

    • setConf

      public SynapseNotebookActivity setConf(Object conf)
      Set the conf property: Spark configuration properties, which will override the 'conf' of the notebook you provide.
      Parameters:
      conf - the conf value to set.
      Returns:
      the SynapseNotebookActivity object itself.

    • getDriverSize

      public Object getDriverSize()
      Get the driverSize property: Number of core and memory to be used for driver allocated in the specified Spark pool for the session, which will be used for overriding 'driverCores' and 'driverMemory' of the notebook you provide. Type: string (or Expression with resultType string).
      Returns:
      the driverSize value.

    • setDriverSize

      public SynapseNotebookActivity setDriverSize(Object driverSize)
      Set the driverSize property: Number of core and memory to be used for driver allocated in the specified Spark pool for the session, which will be used for overriding 'driverCores' and 'driverMemory' of the notebook you provide. Type: string (or Expression with resultType string).
      Parameters:
      driverSize - the driverSize value to set.
      Returns:
      the SynapseNotebookActivity object itself.

    • getNumExecutors

      public Integer getNumExecutors()
      Get the numExecutors property: Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide.
      Returns:
      the numExecutors value.

    • setNumExecutors

      public SynapseNotebookActivity setNumExecutors(Integer numExecutors)
      Set the numExecutors property: Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide.
      Parameters:
      numExecutors - the numExecutors 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.