Class SynapseSparkJobDefinitionActivity


public class SynapseSparkJobDefinitionActivity extends ExecutionActivity
Execute spark job activity.
  • Constructor Details

    • SynapseSparkJobDefinitionActivity

      public SynapseSparkJobDefinitionActivity()
  • Method Details

    • getSparkJob

      public SynapseSparkJobReference getSparkJob()
      Get the sparkJob property: Synapse spark job reference.
      Returns:
      the sparkJob value.
    • setSparkJob

      Set the sparkJob property: Synapse spark job reference.
      Parameters:
      sparkJob - the sparkJob value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity object itself.
    • getArguments

      public List<Object> getArguments()
      Get the arguments property: User specified arguments to SynapseSparkJobDefinitionActivity.
      Returns:
      the arguments value.
    • setArguments

      public SynapseSparkJobDefinitionActivity setArguments(List<Object> arguments)
      Set the arguments property: User specified arguments to SynapseSparkJobDefinitionActivity.
      Parameters:
      arguments - the arguments value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity object itself.
    • getFile

      public Object getFile()
      Get the file property: The main file used for the job, which will override the 'file' of the spark job definition you provide. Type: string (or Expression with resultType string).
      Returns:
      the file value.
    • setFile

      Set the file property: The main file used for the job, which will override the 'file' of the spark job definition you provide. Type: string (or Expression with resultType string).
      Parameters:
      file - the file value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity object itself.
    • getClassName

      public Object getClassName()
      Get the className property: The fully-qualified identifier or the main class that is in the main definition file, which will override the 'className' of the spark job definition you provide. Type: string (or Expression with resultType string).
      Returns:
      the className value.
    • setClassName

      public SynapseSparkJobDefinitionActivity setClassName(Object className)
      Set the className property: The fully-qualified identifier or the main class that is in the main definition file, which will override the 'className' of the spark job definition you provide. Type: string (or Expression with resultType string).
      Parameters:
      className - the className value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity object itself.
    • getFiles

      public List<Object> getFiles()
      Get the files property: Additional files used for reference in the main definition file, which will override the 'files' of the spark job definition you provide.
      Returns:
      the files value.
    • setFiles

      public SynapseSparkJobDefinitionActivity setFiles(List<Object> files)
      Set the files property: Additional files used for reference in the main definition file, which will override the 'files' of the spark job definition you provide.
      Parameters:
      files - the files value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity object itself.
    • getTargetBigDataPool

      public BigDataPoolParametrizationReference getTargetBigDataPool()
      Get the targetBigDataPool property: The name of the big data pool which will be used to execute the spark batch job, which will override the 'targetBigDataPool' of the spark job definition you provide.
      Returns:
      the targetBigDataPool value.
    • setTargetBigDataPool

      public SynapseSparkJobDefinitionActivity setTargetBigDataPool(BigDataPoolParametrizationReference targetBigDataPool)
      Set the targetBigDataPool property: The name of the big data pool which will be used to execute the spark batch job, which will override the 'targetBigDataPool' of the spark job definition you provide.
      Parameters:
      targetBigDataPool - the targetBigDataPool value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity 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 job, which will be used for overriding 'executorCores' and 'executorMemory' of the spark job definition you provide. Type: string (or Expression with resultType string).
      Returns:
      the executorSize value.
    • setExecutorSize

      public SynapseSparkJobDefinitionActivity 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 job, which will be used for overriding 'executorCores' and 'executorMemory' of the spark job definition you provide. Type: string (or Expression with resultType string).
      Parameters:
      executorSize - the executorSize value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity object itself.
    • getConf

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

      Set the conf property: Spark configuration properties, which will override the 'conf' of the spark job definition you provide.
      Parameters:
      conf - the conf value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity 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 job, which will be used for overriding 'driverCores' and 'driverMemory' of the spark job definition you provide. Type: string (or Expression with resultType string).
      Returns:
      the driverSize value.
    • setDriverSize

      public SynapseSparkJobDefinitionActivity 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 job, which will be used for overriding 'driverCores' and 'driverMemory' of the spark job definition you provide. Type: string (or Expression with resultType string).
      Parameters:
      driverSize - the driverSize value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity object itself.
    • getNumExecutors

      public Integer getNumExecutors()
      Get the numExecutors property: Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide.
      Returns:
      the numExecutors value.
    • setNumExecutors

      public SynapseSparkJobDefinitionActivity setNumExecutors(Integer numExecutors)
      Set the numExecutors property: Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide.
      Parameters:
      numExecutors - the numExecutors value to set.
      Returns:
      the SynapseSparkJobDefinitionActivity object itself.
    • setLinkedServiceName

      public SynapseSparkJobDefinitionActivity 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

      Set the policy property: Activity policy.
      Overrides:
      setPolicy in class ExecutionActivity
      Parameters:
      policy - the policy value to set.
      Returns:
      the ExecutionActivity object itself.
    • setName

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