Package com.azure.resourcemanager.datafactory.models

Class SynapseNotebookActivity

java.lang.Object
com.azure.resourcemanager.datafactory.models.Activity
com.azure.resourcemanager.datafactory.models.ExecutionActivity
com.azure.resourcemanager.datafactory.models.SynapseNotebookActivity
public final class SynapseNotebookActivity extends ExecutionActivity
Execute Synapse notebook activity.

  • Constructor Details

    • SynapseNotebookActivity

      public SynapseNotebookActivity()
      Creates an instance of SynapseNotebookActivity class.

  • Method Details

    • withLinkedServiceName

      public SynapseNotebookActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)
      Set the linkedServiceName property: Linked service reference.
      Overrides:
      withLinkedServiceName in class ExecutionActivity
      Parameters:
      linkedServiceName - the linkedServiceName value to set.
      Returns:
      the ExecutionActivity object itself.

    • withPolicy

      public SynapseNotebookActivity withPolicy(ActivityPolicy policy)
      Set the policy property: Activity policy.
      Overrides:
      withPolicy in class ExecutionActivity
      Parameters:
      policy - the policy value to set.
      Returns:
      the ExecutionActivity object itself.

    • withName

      public SynapseNotebookActivity withName(String name)
      Set the name property: Activity name.
      Overrides:
      withName in class ExecutionActivity
      Parameters:
      name - the name value to set.
      Returns:
      the Activity object itself.

    • withDescription

      public SynapseNotebookActivity withDescription(String description)
      Set the description property: Activity description.
      Overrides:
      withDescription in class ExecutionActivity
      Parameters:
      description - the description value to set.
      Returns:
      the Activity object itself.

    • withDependsOn

      public SynapseNotebookActivity withDependsOn(List<ActivityDependency> dependsOn)
      Set the dependsOn property: Activity depends on condition.
      Overrides:
      withDependsOn in class ExecutionActivity
      Parameters:
      dependsOn - the dependsOn value to set.
      Returns:
      the Activity object itself.

    • withUserProperties

      public SynapseNotebookActivity withUserProperties(List<UserProperty> userProperties)
      Set the userProperties property: Activity user properties.
      Overrides:
      withUserProperties in class ExecutionActivity
      Parameters:
      userProperties - the userProperties value to set.
      Returns:
      the Activity object itself.

    • notebook

      public SynapseNotebookReference notebook()
      Get the notebook property: Synapse notebook reference.
      Returns:
      the notebook value.

    • withNotebook

      public SynapseNotebookActivity withNotebook(SynapseNotebookReference notebook)
      Set the notebook property: Synapse notebook reference.
      Parameters:
      notebook - the notebook value to set.
      Returns:
      the SynapseNotebookActivity object itself.

    • sparkPool

      public BigDataPoolParametrizationReference sparkPool()
      Get the sparkPool property: The name of the big data pool which will be used to execute the notebook.
      Returns:
      the sparkPool value.

    • withSparkPool

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

    • parameters

      public Map<String,NotebookParameter> parameters()
      Get the parameters property: Notebook parameters.
      Returns:
      the parameters value.

    • withParameters

      public SynapseNotebookActivity withParameters(Map<String,NotebookParameter> parameters)
      Set the parameters property: Notebook parameters.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the SynapseNotebookActivity object itself.

    • executorSize

      public Object executorSize()
      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.

    • withExecutorSize

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

    • conf

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

    • withConf

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

    • driverSize

      public Object driverSize()
      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.

    • withDriverSize

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

    • numExecutors

      public Integer numExecutors()
      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.

    • withNumExecutors

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

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ExecutionActivity
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.