Feedback Edit

SparkSession Class

  • Reference

SparkSession.

All required parameters must be populated in order to send to Azure.

Inheritance
Model
SparkSession

Constructor

SparkSession(*, id: int, livy_info: Optional[azure.synapse.spark.models._models_py3.SparkSessionState] = None, name: Optional[str] = None, workspace_name: Optional[str] = None, spark_pool_name: Optional[str] = None, submitter_name: Optional[str] = None, submitter_id: Optional[str] = None, artifact_id: Optional[str] = None, job_type: Optional[Union[str, azure.synapse.spark.models._spark_client_enums.SparkJobType]] = None, result: Optional[Union[str, azure.synapse.spark.models._spark_client_enums.SparkSessionResultType]] = None, scheduler: Optional[azure.synapse.spark.models._models_py3.SparkScheduler] = None, plugin: Optional[azure.synapse.spark.models._models_py3.SparkServicePlugin] = None, errors: Optional[List[azure.synapse.spark.models._models_py3.SparkServiceError]] = None, tags: Optional[Dict[str, str]] = None, app_id: Optional[str] = None, app_info: Optional[Dict[str, str]] = None, state: Optional[str] = None, log_lines: Optional[List[str]] = None, **kwargs)

Parameters

livy_info
SparkSessionState
Required
name
str
Required
workspace_name
str
Required
spark_pool_name
str
Required
submitter_name
str
Required
submitter_id
str
Required
artifact_id
str
Required
job_type
str or SparkJobType
Required

The job type. Possible values include: "SparkBatch", "SparkSession".

result
str or SparkSessionResultType
Required

Possible values include: "Uncertain", "Succeeded", "Failed", "Cancelled".

scheduler
SparkScheduler
Required
plugin
SparkServicePlugin
Required
errors
list[SparkServiceError]
Required
tags
dict[str, str]
Required

A set of tags. Dictionary of <string>.

id
int
Required

Required.

app_id
str
Required
app_info
dict[str, str]
Required

Dictionary of <string>.

state
str
Required
log_lines
list[str]
Required