RunNotebookSparkSessionOptions Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.15

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.models.RunNotebookSparkSessionOptions

public final class RunNotebookSparkSessionOptions

The RunNotebookSparkSessionOptions model.

Constructor Summary

Constructor	Description
RunNotebookSparkSessionOptions()	Creates an instance of RunNotebookSparkSessionOptions class.

Method Summary

Modifier and Type	Method and Description
List<String>	getArchives() Get the archives property: Archives to be used in this session.
Map<String,String>	getConfiguration() Get the configuration property: Spark configuration properties.
Integer	getDriverCores() Get the driverCores property: Number of cores to use for the driver process.
String	getDriverMemory() Get the driverMemory property: Amount of memory to use for the driver process.
Integer	getExecutorCores() Get the executorCores property: Number of cores to use for each executor.
Integer	getExecutorCount() Get the executorCount property: Number of executors to launch for this session.
String	getExecutorMemory() Get the executorMemory property: Amount of memory to use per executor process.
List<String>	getFiles() Get the files property: files to be used in this session.
Integer	getHeartbeatTimeoutInSecond() Get the heartbeatTimeoutInSecond property: Timeout in second to which session be orphaned.
List<String>	getJars() Get the jars property: jars to be used in this session.
String	getKind() Get the kind property: The session kind.
String	getName() Get the name property: The name of this session.
String	getProxyUser() Get the proxyUser property: User to impersonate when starting the session.
List<String>	getPythonFiles() Get the pythonFiles property: Python files to be used in this session.
Object	getQueue() Get the queue property: The name of the YARN queue to which submitted.
Map<String,String>	getTags() Get the tags property: Dictionary of .
Boolean	isQueueable() Get the isQueueable property: Whether to queue session creation if Spark pool doesn't have enough capacity.
RunNotebookSparkSessionOptions	setArchives(List<String> archives) Set the archives property: Archives to be used in this session.
RunNotebookSparkSessionOptions	setConfiguration(Map<String,String> configuration) Set the configuration property: Spark configuration properties.
RunNotebookSparkSessionOptions	setDriverCores(Integer driverCores) Set the driverCores property: Number of cores to use for the driver process.
RunNotebookSparkSessionOptions	setDriverMemory(String driverMemory) Set the driverMemory property: Amount of memory to use for the driver process.
RunNotebookSparkSessionOptions	setExecutorCores(Integer executorCores) Set the executorCores property: Number of cores to use for each executor.
RunNotebookSparkSessionOptions	setExecutorCount(Integer executorCount) Set the executorCount property: Number of executors to launch for this session.
RunNotebookSparkSessionOptions	setExecutorMemory(String executorMemory) Set the executorMemory property: Amount of memory to use per executor process.
RunNotebookSparkSessionOptions	setFiles(List<String> files) Set the files property: files to be used in this session.
RunNotebookSparkSessionOptions	setHeartbeatTimeoutInSecond(Integer heartbeatTimeoutInSecond) Set the heartbeatTimeoutInSecond property: Timeout in second to which session be orphaned.
RunNotebookSparkSessionOptions	setIsQueueable(Boolean isQueueable) Set the isQueueable property: Whether to queue session creation if Spark pool doesn't have enough capacity.
RunNotebookSparkSessionOptions	setJars(List<String> jars) Set the jars property: jars to be used in this session.
RunNotebookSparkSessionOptions	setKind(String kind) Set the kind property: The session kind.
RunNotebookSparkSessionOptions	setName(String name) Set the name property: The name of this session.
RunNotebookSparkSessionOptions	setProxyUser(String proxyUser) Set the proxyUser property: User to impersonate when starting the session.
RunNotebookSparkSessionOptions	setPythonFiles(List<String> pythonFiles) Set the pythonFiles property: Python files to be used in this session.
RunNotebookSparkSessionOptions	setQueue(Object queue) Set the queue property: The name of the YARN queue to which submitted.
RunNotebookSparkSessionOptions	setTags(Map<String,String> tags) Set the tags property: Dictionary of .

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RunNotebookSparkSessionOptions

public RunNotebookSparkSessionOptions()

Creates an instance of RunNotebookSparkSessionOptions class.

Method Details

getArchives

public List getArchives()

Get the archives property: Archives to be used in this session.

Returns:

the archives value.

getConfiguration

public Map getConfiguration()

Get the configuration property: Spark configuration properties.

Returns:

the configuration value.

getDriverCores

public Integer getDriverCores()

Get the driverCores property: Number of cores to use for the driver process.

Returns:

the driverCores value.

getDriverMemory

public String getDriverMemory()

Get the driverMemory property: Amount of memory to use for the driver process.

Returns:

the driverMemory value.

getExecutorCores

public Integer getExecutorCores()

Get the executorCores property: Number of cores to use for each executor.

Returns:

the executorCores value.

getExecutorCount

public Integer getExecutorCount()

Get the executorCount property: Number of executors to launch for this session.

Returns:

the executorCount value.

getExecutorMemory

public String getExecutorMemory()

Get the executorMemory property: Amount of memory to use per executor process.

Returns:

the executorMemory value.

getFiles

public List getFiles()

Get the files property: files to be used in this session.

Returns:

the files value.

getHeartbeatTimeoutInSecond

public Integer getHeartbeatTimeoutInSecond()

Get the heartbeatTimeoutInSecond property: Timeout in second to which session be orphaned.

Returns:

the heartbeatTimeoutInSecond value.

getJars

public List getJars()

Get the jars property: jars to be used in this session.

Returns:

the jars value.

getKind

public String getKind()

Get the kind property: The session kind.

Returns:

the kind value.

getName

public String getName()

Get the name property: The name of this session.

Returns:

the name value.

getProxyUser

public String getProxyUser()

Get the proxyUser property: User to impersonate when starting the session.

Returns:

the proxyUser value.

getPythonFiles

public List getPythonFiles()

Get the pythonFiles property: Python files to be used in this session.

Returns:

the pythonFiles value.

getQueue

public Object getQueue()

Get the queue property: The name of the YARN queue to which submitted.

Returns:

the queue value.

getTags

public Map getTags()

Get the tags property: Dictionary of .

Returns:

the tags value.

isQueueable

public Boolean isQueueable()

Get the isQueueable property: Whether to queue session creation if Spark pool doesn't have enough capacity. Default value is true in notebook runs API.

Returns:

the isQueueable value.

setArchives

public RunNotebookSparkSessionOptions setArchives(List archives)

Set the archives property: Archives to be used in this session.

Parameters:

archives - the archives value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setConfiguration

public RunNotebookSparkSessionOptions setConfiguration(Map configuration)

Set the configuration property: Spark configuration properties.

Parameters:

configuration - the configuration value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setDriverCores

public RunNotebookSparkSessionOptions setDriverCores(Integer driverCores)

Set the driverCores property: Number of cores to use for the driver process.

Parameters:

driverCores - the driverCores value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setDriverMemory

public RunNotebookSparkSessionOptions setDriverMemory(String driverMemory)

Set the driverMemory property: Amount of memory to use for the driver process.

Parameters:

driverMemory - the driverMemory value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setExecutorCores

public RunNotebookSparkSessionOptions setExecutorCores(Integer executorCores)

Set the executorCores property: Number of cores to use for each executor.

Parameters:

executorCores - the executorCores value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setExecutorCount

public RunNotebookSparkSessionOptions setExecutorCount(Integer executorCount)

Set the executorCount property: Number of executors to launch for this session.

Parameters:

executorCount - the executorCount value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setExecutorMemory

public RunNotebookSparkSessionOptions setExecutorMemory(String executorMemory)

Set the executorMemory property: Amount of memory to use per executor process.

Parameters:

executorMemory - the executorMemory value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setFiles

public RunNotebookSparkSessionOptions setFiles(List files)

Set the files property: files to be used in this session.

Parameters:

files - the files value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setHeartbeatTimeoutInSecond

public RunNotebookSparkSessionOptions setHeartbeatTimeoutInSecond(Integer heartbeatTimeoutInSecond)

Set the heartbeatTimeoutInSecond property: Timeout in second to which session be orphaned.

Parameters:

heartbeatTimeoutInSecond - the heartbeatTimeoutInSecond value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setIsQueueable

public RunNotebookSparkSessionOptions setIsQueueable(Boolean isQueueable)

Set the isQueueable property: Whether to queue session creation if Spark pool doesn't have enough capacity. Default value is true in notebook runs API.

Parameters:

isQueueable - the isQueueable value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setJars

public RunNotebookSparkSessionOptions setJars(List jars)

Set the jars property: jars to be used in this session.

Parameters:

jars - the jars value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setKind

public RunNotebookSparkSessionOptions setKind(String kind)

Set the kind property: The session kind.

Parameters:

kind - the kind value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setName

public RunNotebookSparkSessionOptions setName(String name)

Set the name property: The name of this session.

Parameters:

name - the name value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setProxyUser

public RunNotebookSparkSessionOptions setProxyUser(String proxyUser)

Set the proxyUser property: User to impersonate when starting the session.

Parameters:

proxyUser - the proxyUser value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setPythonFiles

public RunNotebookSparkSessionOptions setPythonFiles(List pythonFiles)

Set the pythonFiles property: Python files to be used in this session.

Parameters:

pythonFiles - the pythonFiles value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setQueue

public RunNotebookSparkSessionOptions setQueue(Object queue)

Set the queue property: The name of the YARN queue to which submitted.

Parameters:

queue - the queue value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.

setTags

public RunNotebookSparkSessionOptions setTags(Map tags)

Set the tags property: Dictionary of .

Parameters:

tags - the tags value to set.

Returns:

the RunNotebookSparkSessionOptions object itself.