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

public final class RunNotebookSnapshot

Run notebook snapshot.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	getExitValue() Get the exitValue property: Output of exit command.
String	getId() Get the id property: Run notebook runId.
String	getNotebook() Get the notebook property: Notebook name.
NotebookResource	getNotebookContent() Get the notebookContent property: Notebook resource type.
Map<String,RunNotebookParameter>	getParameters() Get the parameters property: Run notebook parameters.
String	getSessionId() Get the sessionId property: Livy session id.
RunNotebookSparkSessionOptions	getSessionOptions() Get the sessionOptions property: Session properties.
String	getSparkPool() Get the sparkPool property: SparkPool name.
Boolean	isHonorSessionTimeToLive() Get the honorSessionTimeToLive property: Whether session should run till time to live after run completes.
RunNotebookSnapshot	setExitValue(String exitValue) Set the exitValue property: Output of exit command.
RunNotebookSnapshot	setHonorSessionTimeToLive(Boolean honorSessionTimeToLive) Set the honorSessionTimeToLive property: Whether session should run till time to live after run completes.
RunNotebookSnapshot	setId(String id) Set the id property: Run notebook runId.
RunNotebookSnapshot	setNotebook(String notebook) Set the notebook property: Notebook name.
RunNotebookSnapshot	setNotebookContent(NotebookResource notebookContent) Set the notebookContent property: Notebook resource type.
RunNotebookSnapshot	setParameters(Map<String,RunNotebookParameter> parameters) Set the parameters property: Run notebook parameters.
RunNotebookSnapshot	setSessionId(String sessionId) Set the sessionId property: Livy session id.
RunNotebookSnapshot	setSessionOptions(RunNotebookSparkSessionOptions sessionOptions) Set the sessionOptions property: Session properties.
RunNotebookSnapshot	setSparkPool(String sparkPool) Set the sparkPool property: SparkPool name.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RunNotebookSnapshot

public RunNotebookSnapshot()

Creates an instance of RunNotebookSnapshot class.

Method Details

getExitValue

public String getExitValue()

Get the exitValue property: Output of exit command.

Returns:

the exitValue value.

getId

public String getId()

Get the id property: Run notebook runId.

Returns:

the id value.

getNotebook

public String getNotebook()

Get the notebook property: Notebook name.

Returns:

the notebook value.

getNotebookContent

public NotebookResource getNotebookContent()

Get the notebookContent property: Notebook resource type.

Returns:

the notebookContent value.

getParameters

public Map getParameters()

Get the parameters property: Run notebook parameters.

Returns:

the parameters value.

getSessionId

public String getSessionId()

Get the sessionId property: Livy session id.

Returns:

the sessionId value.

getSessionOptions

public RunNotebookSparkSessionOptions getSessionOptions()

Get the sessionOptions property: Session properties.

Returns:

the sessionOptions value.

getSparkPool

public String getSparkPool()

Get the sparkPool property: SparkPool name.

Returns:

the sparkPool value.

isHonorSessionTimeToLive

public Boolean isHonorSessionTimeToLive()

Get the honorSessionTimeToLive property: Whether session should run till time to live after run completes.

Returns:

the honorSessionTimeToLive value.

setExitValue

public RunNotebookSnapshot setExitValue(String exitValue)

Set the exitValue property: Output of exit command.

Parameters:

exitValue - the exitValue value to set.

Returns:

the RunNotebookSnapshot object itself.

setHonorSessionTimeToLive

public RunNotebookSnapshot setHonorSessionTimeToLive(Boolean honorSessionTimeToLive)

Set the honorSessionTimeToLive property: Whether session should run till time to live after run completes.

Parameters:

honorSessionTimeToLive - the honorSessionTimeToLive value to set.

Returns:

the RunNotebookSnapshot object itself.

setId

public RunNotebookSnapshot setId(String id)

Set the id property: Run notebook runId.

Parameters:

id - the id value to set.

Returns:

the RunNotebookSnapshot object itself.

setNotebook

public RunNotebookSnapshot setNotebook(String notebook)

Set the notebook property: Notebook name.

Parameters:

notebook - the notebook value to set.

Returns:

the RunNotebookSnapshot object itself.

setNotebookContent

public RunNotebookSnapshot setNotebookContent(NotebookResource notebookContent)

Set the notebookContent property: Notebook resource type.

Parameters:

notebookContent - the notebookContent value to set.

Returns:

the RunNotebookSnapshot object itself.

setParameters

public RunNotebookSnapshot setParameters(Map parameters)

Set the parameters property: Run notebook parameters.

Parameters:

parameters - the parameters value to set.

Returns:

the RunNotebookSnapshot object itself.

setSessionId

public RunNotebookSnapshot setSessionId(String sessionId)

Set the sessionId property: Livy session id.

Parameters:

sessionId - the sessionId value to set.

Returns:

the RunNotebookSnapshot object itself.

setSessionOptions

public RunNotebookSnapshot setSessionOptions(RunNotebookSparkSessionOptions sessionOptions)

Set the sessionOptions property: Session properties.

Parameters:

sessionOptions - the sessionOptions value to set.

Returns:

the RunNotebookSnapshot object itself.

setSparkPool

public RunNotebookSnapshot setSparkPool(String sparkPool)

Set the sparkPool property: SparkPool name.

Parameters:

sparkPool - the sparkPool value to set.

Returns:

the RunNotebookSnapshot object itself.