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

Implements

JsonSerializable<RunNotebookRequest>

public final class RunNotebookRequest
implements JsonSerializable<RunNotebookRequest>

Run notebook request.

Constructor Summary

Constructor Description
RunNotebookRequest()

Creates an instance of RunNotebookRequest class.

Method Summary

Modifier and Type Method and Description
static RunNotebookRequest fromJson(JsonReader jsonReader)

Reads an instance of RunNotebookRequest from the JsonReader.
String getNotebook()

Get the notebook property: Notebook name.
Map<String,RunNotebookParameter> getParameters()

Get the parameters property: Run notebook parameters.
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.
RunNotebookRequest setHonorSessionTimeToLive(Boolean honorSessionTimeToLive)

Set the honorSessionTimeToLive property: Whether session should run till time to live after run completes.
RunNotebookRequest setNotebook(String notebook)

Set the notebook property: Notebook name.
RunNotebookRequest setParameters(Map<String,RunNotebookParameter> parameters)

Set the parameters property: Run notebook parameters.
RunNotebookRequest setSessionOptions(RunNotebookSparkSessionOptions sessionOptions)

Set the sessionOptions property: Session properties.
RunNotebookRequest setSparkPool(String sparkPool)

Set the sparkPool property: SparkPool name.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RunNotebookRequest

public RunNotebookRequest()

Creates an instance of RunNotebookRequest class.

Method Details

fromJson

public static RunNotebookRequest fromJson(JsonReader jsonReader)

Reads an instance of RunNotebookRequest from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the RunNotebookRequest.

getNotebook

public String getNotebook()

Get the notebook property: Notebook name.

Returns:

the notebook value.

getParameters

public Map<String,RunNotebookParameter> getParameters()

Get the parameters property: Run notebook parameters.

Returns:

the parameters 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.

setHonorSessionTimeToLive

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

setNotebook

public RunNotebookRequest setNotebook(String notebook)

Set the notebook property: Notebook name.

Parameters:

notebook - the notebook value to set.

Returns:

the RunNotebookRequest object itself.

setParameters

public RunNotebookRequest setParameters(Map<String,RunNotebookParameter> parameters)

Set the parameters property: Run notebook parameters.

Parameters:

parameters - the parameters value to set.

Returns:

the RunNotebookRequest object itself.

setSessionOptions

public RunNotebookRequest setSessionOptions(RunNotebookSparkSessionOptions sessionOptions)

Set the sessionOptions property: Session properties.

Parameters:

sessionOptions - the sessionOptions value to set.

Returns:

the RunNotebookRequest object itself.

setSparkPool

public RunNotebookRequest setSparkPool(String sparkPool)

Set the sparkPool property: SparkPool name.

Parameters:

sparkPool - the sparkPool value to set.

Returns:

the RunNotebookRequest object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to