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

Implements

JsonSerializable<NotebookCellOutputItem>

public final class NotebookCellOutputItem
implements JsonSerializable<NotebookCellOutputItem>

An item of the notebook cell execution output.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static NotebookCellOutputItem	fromJson(JsonReader jsonReader) Reads an instance of NotebookCellOutputItem from the JsonReader.
Object	getData() Get the data property: Output data.
Integer	getExecutionCount() Get the executionCount property: Execution sequence number.
Object	getMetadata() Get the metadata property: Metadata for the output item.
String	getName() Get the name property: For output_type=stream, determines the name of stream (stdout / stderr).
CellOutputType	getOutputType() Get the outputType property: Execution, display, or stream outputs.
Object	getText() Get the text property: For output_type=stream, the stream's text output, represented as a string or an array of strings.
NotebookCellOutputItem	setData(Object data) Set the data property: Output data.
NotebookCellOutputItem	setExecutionCount(Integer executionCount) Set the executionCount property: Execution sequence number.
NotebookCellOutputItem	setMetadata(Object metadata) Set the metadata property: Metadata for the output item.
NotebookCellOutputItem	setName(String name) Set the name property: For output_type=stream, determines the name of stream (stdout / stderr).
NotebookCellOutputItem	setOutputType(CellOutputType outputType) Set the outputType property: Execution, display, or stream outputs.
NotebookCellOutputItem	setText(Object text) Set the text property: For output_type=stream, the stream's text output, represented as a string or an array of strings.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

NotebookCellOutputItem

public NotebookCellOutputItem()

Creates an instance of NotebookCellOutputItem class.

Method Details

fromJson

public static NotebookCellOutputItem fromJson(JsonReader jsonReader)

Reads an instance of NotebookCellOutputItem from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getData

public Object getData()

Get the data property: Output data. Use MIME type as key, and content as value.

Returns:

the data value.

getExecutionCount

public Integer getExecutionCount()

Get the executionCount property: Execution sequence number.

Returns:

the executionCount value.

getMetadata

public Object getMetadata()

Get the metadata property: Metadata for the output item.

Returns:

the metadata value.

getName

public String getName()

Get the name property: For output_type=stream, determines the name of stream (stdout / stderr).

Returns:

the name value.

getOutputType

public CellOutputType getOutputType()

Get the outputType property: Execution, display, or stream outputs.

Returns:

the outputType value.

getText

public Object getText()

Get the text property: For output_type=stream, the stream's text output, represented as a string or an array of strings.

Returns:

the text value.

setData

public NotebookCellOutputItem setData(Object data)

Set the data property: Output data. Use MIME type as key, and content as value.

Parameters:

data - the data value to set.

Returns:

the NotebookCellOutputItem object itself.

setExecutionCount

public NotebookCellOutputItem setExecutionCount(Integer executionCount)

Set the executionCount property: Execution sequence number.

Parameters:

executionCount - the executionCount value to set.

Returns:

the NotebookCellOutputItem object itself.

setMetadata

public NotebookCellOutputItem setMetadata(Object metadata)

Set the metadata property: Metadata for the output item.

Parameters:

metadata - the metadata value to set.

Returns:

the NotebookCellOutputItem object itself.

setName

public NotebookCellOutputItem setName(String name)

Set the name property: For output_type=stream, determines the name of stream (stdout / stderr).

Parameters:

name - the name value to set.

Returns:

the NotebookCellOutputItem object itself.

setOutputType

public NotebookCellOutputItem setOutputType(CellOutputType outputType)

Set the outputType property: Execution, display, or stream outputs.

Parameters:

outputType - the outputType value to set.

Returns:

the NotebookCellOutputItem object itself.

setText

public NotebookCellOutputItem setText(Object text)

Set the text property: For output_type=stream, the stream's text output, represented as a string or an array of strings.

Parameters:

text - the text value to set.

Returns:

the NotebookCellOutputItem object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException