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

Implements

JsonSerializable<Notebook>

public final class Notebook
implements JsonSerializable<Notebook>

Notebook.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static Notebook	fromJson(JsonReader jsonReader) Reads an instance of Notebook from the JsonReader.
Map<String,Object>	getAdditionalProperties() Get the additionalProperties property: Notebook.
BigDataPoolReference	getBigDataPool() Get the bigDataPool property: Big data pool reference.
List<NotebookCell>	getCells() Get the cells property: Array of cells of the current notebook.
String	getDescription() Get the description property: The description of the notebook.
NotebookFolder	getFolder() Get the folder property: The folder that this notebook is in.
NotebookMetadata	getMetadata() Get the metadata property: Notebook root-level metadata.
int	getNbformat() Get the nbformat property: Notebook format (major number).
int	getNbformatMinor() Get the nbformatMinor property: Notebook format (minor number).
NotebookSessionProperties	getSessionProperties() Get the sessionProperties property: Session properties.
SparkConfigurationReference	getTargetSparkConfiguration() Get the targetSparkConfiguration property: The spark configuration of the spark job.
Notebook	setAdditionalProperties(Map<String,Object> additionalProperties) Set the additionalProperties property: Notebook.
Notebook	setBigDataPool(BigDataPoolReference bigDataPool) Set the bigDataPool property: Big data pool reference.
Notebook	setCells(List<NotebookCell> cells) Set the cells property: Array of cells of the current notebook.
Notebook	setDescription(String description) Set the description property: The description of the notebook.
Notebook	setFolder(NotebookFolder folder) Set the folder property: The folder that this notebook is in.
Notebook	setMetadata(NotebookMetadata metadata) Set the metadata property: Notebook root-level metadata.
Notebook	setNbformat(int nbformat) Set the nbformat property: Notebook format (major number).
Notebook	setNbformatMinor(int nbformatMinor) Set the nbformatMinor property: Notebook format (minor number).
Notebook	setSessionProperties(NotebookSessionProperties sessionProperties) Set the sessionProperties property: Session properties.
Notebook	setTargetSparkConfiguration(SparkConfigurationReference targetSparkConfiguration) Set the targetSparkConfiguration property: The spark configuration of the spark job.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Notebook

public Notebook()

Creates an instance of Notebook class.

Method Details

fromJson

public static Notebook fromJson(JsonReader jsonReader)

Reads an instance of Notebook from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Notebook 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.

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Get the additionalProperties property: Notebook.

Returns:

the additionalProperties value.

getBigDataPool

public BigDataPoolReference getBigDataPool()

Get the bigDataPool property: Big data pool reference.

Returns:

the bigDataPool value.

getCells

public List<NotebookCell> getCells()

Get the cells property: Array of cells of the current notebook.

Returns:

the cells value.

getDescription

public String getDescription()

Get the description property: The description of the notebook.

Returns:

the description value.

getFolder

public NotebookFolder getFolder()

Get the folder property: The folder that this notebook is in. If not specified, this notebook will appear at the root level.

Returns:

the folder value.

getMetadata

public NotebookMetadata getMetadata()

Get the metadata property: Notebook root-level metadata.

Returns:

the metadata value.

getNbformat

public int getNbformat()

Get the nbformat property: Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.

Returns:

the nbformat value.

getNbformatMinor

public int getNbformatMinor()

Get the nbformatMinor property: Notebook format (minor number). Incremented for backward compatible changes to the notebook format.

Returns:

the nbformatMinor value.

getSessionProperties

public NotebookSessionProperties getSessionProperties()

Get the sessionProperties property: Session properties.

Returns:

the sessionProperties value.

getTargetSparkConfiguration

public SparkConfigurationReference getTargetSparkConfiguration()

Get the targetSparkConfiguration property: The spark configuration of the spark job.

Returns:

the targetSparkConfiguration value.

setAdditionalProperties

public Notebook setAdditionalProperties(Map<String,Object> additionalProperties)

Set the additionalProperties property: Notebook.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the Notebook object itself.

setBigDataPool

public Notebook setBigDataPool(BigDataPoolReference bigDataPool)

Set the bigDataPool property: Big data pool reference.

Parameters:

bigDataPool - the bigDataPool value to set.

Returns:

the Notebook object itself.

setCells

public Notebook setCells(List<NotebookCell> cells)

Set the cells property: Array of cells of the current notebook.

Parameters:

cells - the cells value to set.

Returns:

the Notebook object itself.

setDescription

public Notebook setDescription(String description)

Set the description property: The description of the notebook.

Parameters:

description - the description value to set.

Returns:

the Notebook object itself.

setFolder

public Notebook setFolder(NotebookFolder folder)

Set the folder property: The folder that this notebook is in. If not specified, this notebook will appear at the root level.

Parameters:

folder - the folder value to set.

Returns:

the Notebook object itself.

setMetadata

public Notebook setMetadata(NotebookMetadata metadata)

Set the metadata property: Notebook root-level metadata.

Parameters:

metadata - the metadata value to set.

Returns:

the Notebook object itself.

setNbformat

public Notebook setNbformat(int nbformat)

Set the nbformat property: Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.

Parameters:

nbformat - the nbformat value to set.

Returns:

the Notebook object itself.

setNbformatMinor

public Notebook setNbformatMinor(int nbformatMinor)

Set the nbformatMinor property: Notebook format (minor number). Incremented for backward compatible changes to the notebook format.

Parameters:

nbformatMinor - the nbformatMinor value to set.

Returns:

the Notebook object itself.

setSessionProperties

public Notebook setSessionProperties(NotebookSessionProperties sessionProperties)

Set the sessionProperties property: Session properties.

Parameters:

sessionProperties - the sessionProperties value to set.

Returns:

the Notebook object itself.

setTargetSparkConfiguration

public Notebook setTargetSparkConfiguration(SparkConfigurationReference targetSparkConfiguration)

Set the targetSparkConfiguration property: The spark configuration of the spark job.

Parameters:

targetSparkConfiguration - the targetSparkConfiguration value to set.

Returns:

the Notebook object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException