NotebookSessionProperties Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

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

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

Implements

JsonSerializable<NotebookSessionProperties>

public final class NotebookSessionProperties
implements JsonSerializable<NotebookSessionProperties>

Session properties.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static NotebookSessionProperties	fromJson(JsonReader jsonReader) Reads an instance of NotebookSessionProperties from the JsonReader.
int	getDriverCores() Get the driverCores property: Number of cores to use for the driver.
String	getDriverMemory() Get the driverMemory property: Amount of memory to use for the driver process.
int	getExecutorCores() Get the executorCores property: Number of cores to use for each executor.
String	getExecutorMemory() Get the executorMemory property: Amount of memory to use per executor process.
int	getNumExecutors() Get the numExecutors property: Number of executors to launch for this session.
NotebookSessionProperties	setDriverCores(int driverCores) Set the driverCores property: Number of cores to use for the driver.
NotebookSessionProperties	setDriverMemory(String driverMemory) Set the driverMemory property: Amount of memory to use for the driver process.
NotebookSessionProperties	setExecutorCores(int executorCores) Set the executorCores property: Number of cores to use for each executor.
NotebookSessionProperties	setExecutorMemory(String executorMemory) Set the executorMemory property: Amount of memory to use per executor process.
NotebookSessionProperties	setNumExecutors(int numExecutors) Set the numExecutors property: Number of executors to launch for this session.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

NotebookSessionProperties

public NotebookSessionProperties()

Creates an instance of NotebookSessionProperties class.

Method Details

fromJson

public static NotebookSessionProperties fromJson(JsonReader jsonReader)

Reads an instance of NotebookSessionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of NotebookSessionProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getDriverCores

public int getDriverCores()

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

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 int getExecutorCores()

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

Returns:

the executorCores value.

getExecutorMemory

public String getExecutorMemory()

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

Returns:

the executorMemory value.

getNumExecutors

public int getNumExecutors()

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

Returns:

the numExecutors value.

setDriverCores

public NotebookSessionProperties setDriverCores(int driverCores)

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

Parameters:

driverCores - the driverCores value to set.

Returns:

the NotebookSessionProperties object itself.

setDriverMemory

public NotebookSessionProperties 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 NotebookSessionProperties object itself.

setExecutorCores

public NotebookSessionProperties setExecutorCores(int executorCores)

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

Parameters:

executorCores - the executorCores value to set.

Returns:

the NotebookSessionProperties object itself.

setExecutorMemory

public NotebookSessionProperties setExecutorMemory(String executorMemory)

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

Parameters:

executorMemory - the executorMemory value to set.

Returns:

the NotebookSessionProperties object itself.

setNumExecutors

public NotebookSessionProperties setNumExecutors(int numExecutors)

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

Parameters:

numExecutors - the numExecutors value to set.

Returns:

the NotebookSessionProperties object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException