Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/synapse-spark

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

LivyStatementStates

LivyStatementStates: string

Defines values for LivyStatementStates.
KnownLivyStatementStates can be used interchangeably with LivyStatementStates, this enum contains the known values that the service supports.

Known values supported by the service

waiting
running
available
error
cancelling
cancelled

LivyStates

LivyStates: string

Defines values for LivyStates.
KnownLivyStates can be used interchangeably with LivyStates, this enum contains the known values that the service supports.

Known values supported by the service

not_started
starting
idle
busy
shutting_down
error
dead
killed
success
running
recovering

PluginCurrentState

PluginCurrentState: string

Defines values for PluginCurrentState.
KnownPluginCurrentState can be used interchangeably with PluginCurrentState, this enum contains the known values that the service supports.

Known values supported by the service

Preparation
ResourceAcquisition
Queued
Submission
Monitoring
Cleanup
Ended

SchedulerCurrentState

SchedulerCurrentState: string

Defines values for SchedulerCurrentState.
KnownSchedulerCurrentState can be used interchangeably with SchedulerCurrentState, this enum contains the known values that the service supports.

Known values supported by the service

Queued
Scheduled
Ended

SparkBatchCreateSparkBatchJobResponse

SparkBatchCreateSparkBatchJobResponse: SparkBatchJob

Contains response data for the createSparkBatchJob operation.

SparkBatchGetSparkBatchJobResponse

SparkBatchGetSparkBatchJobResponse: SparkBatchJob

Contains response data for the getSparkBatchJob operation.

SparkBatchGetSparkBatchJobsResponse

SparkBatchGetSparkBatchJobsResponse: SparkBatchJobCollection

Contains response data for the getSparkBatchJobs operation.

SparkBatchJobResultType

SparkBatchJobResultType: string

Defines values for SparkBatchJobResultType.
KnownSparkBatchJobResultType can be used interchangeably with SparkBatchJobResultType, this enum contains the known values that the service supports.

Known values supported by the service

Uncertain
Succeeded
Failed
Cancelled

SparkErrorSource

SparkErrorSource: string

Defines values for SparkErrorSource.
KnownSparkErrorSource can be used interchangeably with SparkErrorSource, this enum contains the known values that the service supports.

Known values supported by the service

System
User
Unknown
Dependency

SparkJobType

SparkJobType: string

Defines values for SparkJobType.
KnownSparkJobType can be used interchangeably with SparkJobType, this enum contains the known values that the service supports.

Known values supported by the service

SparkBatch
SparkSession

SparkSessionCancelSparkStatementResponse

SparkSessionCancelSparkStatementResponse: SparkStatementCancellationResult

Contains response data for the cancelSparkStatement operation.

SparkSessionCreateSparkSessionResponse

SparkSessionCreateSparkSessionResponse: SparkSession

Contains response data for the createSparkSession operation.

SparkSessionCreateSparkStatementResponse

SparkSessionCreateSparkStatementResponse: SparkStatement

Contains response data for the createSparkStatement operation.

SparkSessionGetSparkSessionResponse

SparkSessionGetSparkSessionResponse: SparkSession

Contains response data for the getSparkSession operation.

SparkSessionGetSparkSessionsResponse

SparkSessionGetSparkSessionsResponse: SparkSessionCollection

Contains response data for the getSparkSessions operation.

SparkSessionGetSparkStatementResponse

SparkSessionGetSparkStatementResponse: SparkStatement

Contains response data for the getSparkStatement operation.

SparkSessionGetSparkStatementsResponse

SparkSessionGetSparkStatementsResponse: SparkStatementCollection

Contains response data for the getSparkStatements operation.

SparkSessionResultType

SparkSessionResultType: string

Defines values for SparkSessionResultType.
KnownSparkSessionResultType can be used interchangeably with SparkSessionResultType, this enum contains the known values that the service supports.

Known values supported by the service

Uncertain
Succeeded
Failed
Cancelled

SparkStatementLanguageType

SparkStatementLanguageType: string

Defines values for SparkStatementLanguageType.
KnownSparkStatementLanguageType can be used interchangeably with SparkStatementLanguageType, this enum contains the known values that the service supports.

Known values supported by the service

spark
pyspark
dotnetspark
sql

Variables

Const createSpan

createSpan: any = createSpanFunction({namespace: "Azure.Synapse.Spark",packagePrefix: "Microsoft.Synapse"})

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Object literals

Const SparkBatchJob

SparkBatchJob: object

type

type: object

className

className: string = "SparkBatchJob"

name

name: string = "Composite"

modelProperties

modelProperties: object

appId

appId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "appId"

type

type: object

name

name: string = "String"

appInfo

appInfo: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "appInfo"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

artifactId

artifactId: object

serializedName

serializedName: string = "artifactId"

type

type: object

name

name: string = "String"

errors

errors: object

serializedName

serializedName: string = "errorInfo"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SparkServiceError"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "Number"

jobType

jobType: object

serializedName

serializedName: string = "jobType"

type

type: object

name

name: string = "String"

livyInfo

livyInfo: object

serializedName

serializedName: string = "livyInfo"

type

type: object

className

className: string = "SparkBatchJobState"

name

name: string = "Composite"

logLines

logLines: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "log"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

plugin

plugin: object

serializedName

serializedName: string = "pluginInfo"

type

type: object

className

className: string = "SparkServicePlugin"

name

name: string = "Composite"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

name

name: string = "String"

scheduler

scheduler: object

serializedName

serializedName: string = "schedulerInfo"

type

type: object

className

className: string = "SparkScheduler"

name

name: string = "Composite"

sparkPoolName

sparkPoolName: object

serializedName

serializedName: string = "sparkPoolName"

type

type: object

name

name: string = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: string = "String"

submitterId

submitterId: object

serializedName

serializedName: string = "submitterId"

type

type: object

name

name: string = "String"

submitterName

submitterName: object

serializedName

serializedName: string = "submitterName"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

workspaceName

workspaceName: object

serializedName

serializedName: string = "workspaceName"

type

type: object

name

name: string = "String"

Const SparkBatchJobCollection

SparkBatchJobCollection: object

type

type: object

className

className: string = "SparkBatchJobCollection"

name

name: string = "Composite"

modelProperties

modelProperties: object

from

from: object

required

required: boolean = true

serializedName

serializedName: string = "from"

type

type: object

name

name: string = "Number"

sessions

sessions: object

serializedName

serializedName: string = "sessions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SparkBatchJob"

name

name: string = "Composite"

total

total: object

required

required: boolean = true

serializedName

serializedName: string = "total"

type

type: object

name

name: string = "Number"

Const SparkBatchJobOptions

SparkBatchJobOptions: object

type

type: object

className

className: string = "SparkBatchJobOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

archives

archives: object

serializedName

serializedName: string = "archives"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

arguments

arguments: object

serializedName

serializedName: string = "args"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

artifactId

artifactId: object

serializedName

serializedName: string = "artifactId"

type

type: object

name

name: string = "String"

className

className: object

serializedName

serializedName: string = "className"

type

type: object

name

name: string = "String"

configuration

configuration: object

serializedName

serializedName: string = "conf"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

driverCores

driverCores: object

serializedName

serializedName: string = "driverCores"

type

type: object

name

name: string = "Number"

driverMemory

driverMemory: object

serializedName

serializedName: string = "driverMemory"

type

type: object

name

name: string = "String"

executorCores

executorCores: object

serializedName

serializedName: string = "executorCores"

type

type: object

name

name: string = "Number"

executorCount

executorCount: object

serializedName

serializedName: string = "numExecutors"

type

type: object

name

name: string = "Number"

executorMemory

executorMemory: object

serializedName

serializedName: string = "executorMemory"

type

type: object

name

name: string = "String"

file

file: object

required

required: boolean = true

serializedName

serializedName: string = "file"

type

type: object

name

name: string = "String"

files

files: object

serializedName

serializedName: string = "files"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

jars

jars: object

serializedName

serializedName: string = "jars"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

pythonFiles

pythonFiles: object

serializedName

serializedName: string = "pyFiles"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const SparkBatchJobState

SparkBatchJobState: object

type

type: object

className

className: string = "SparkBatchJobState"

name

name: string = "Composite"

modelProperties

modelProperties: object

currentState

currentState: object

serializedName

serializedName: string = "currentState"

type

type: object

name

name: string = "String"

deadAt

deadAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "deadAt"

type

type: object

name

name: string = "DateTime"

jobCreationRequest

jobCreationRequest: object

serializedName

serializedName: string = "jobCreationRequest"

type

type: object

className

className: string = "SparkRequest"

name

name: string = "Composite"

notStartedAt

notStartedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "notStartedAt"

type

type: object

name

name: string = "DateTime"

recoveringAt

recoveringAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "recoveringAt"

type

type: object

name

name: string = "DateTime"

runningAt

runningAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "runningAt"

type

type: object

name

name: string = "DateTime"

startingAt

startingAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "startingAt"

type

type: object

name

name: string = "DateTime"

successAt

successAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "successAt"

type

type: object

name

name: string = "DateTime"

terminatedAt

terminatedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "killedAt"

type

type: object

name

name: string = "DateTime"

Const SparkRequest

SparkRequest: object

type

type: object

className

className: string = "SparkRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

archives

archives: object

serializedName

serializedName: string = "archives"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

arguments

arguments: object

serializedName

serializedName: string = "args"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

className

className: object

serializedName

serializedName: string = "className"

type

type: object

name

name: string = "String"

configuration

configuration: object

serializedName

serializedName: string = "conf"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

driverCores

driverCores: object

serializedName

serializedName: string = "driverCores"

type

type: object

name

name: string = "Number"

driverMemory

driverMemory: object

serializedName

serializedName: string = "driverMemory"

type

type: object

name

name: string = "String"

executorCores

executorCores: object

serializedName

serializedName: string = "executorCores"

type

type: object

name

name: string = "Number"

executorCount

executorCount: object

serializedName

serializedName: string = "numExecutors"

type

type: object

name

name: string = "Number"

executorMemory

executorMemory: object

serializedName

serializedName: string = "executorMemory"

type

type: object

name

name: string = "String"

file

file: object

serializedName

serializedName: string = "file"

type

type: object

name

name: string = "String"

files

files: object

serializedName

serializedName: string = "files"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

jars

jars: object

serializedName

serializedName: string = "jars"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

pythonFiles

pythonFiles: object

serializedName

serializedName: string = "pyFiles"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const SparkScheduler

SparkScheduler: object

type

type: object

className

className: string = "SparkScheduler"

name

name: string = "Composite"

modelProperties

modelProperties: object

cancellationRequestedAt

cancellationRequestedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "cancellationRequestedAt"

type

type: object

name

name: string = "DateTime"

currentState

currentState: object

serializedName

serializedName: string = "currentState"

type

type: object

name

name: string = "String"

endedAt

endedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "endedAt"

type

type: object

name

name: string = "DateTime"

scheduledAt

scheduledAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "scheduledAt"

type

type: object

name

name: string = "DateTime"

submittedAt

submittedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "submittedAt"

type

type: object

name

name: string = "DateTime"

Const SparkServiceError

SparkServiceError: object

type

type: object

className

className: string = "SparkServiceError"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: string = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

source

source: object

serializedName

serializedName: string = "source"

type

type: object

name

name: string = "String"

Const SparkServicePlugin

SparkServicePlugin: object

type

type: object

className

className: string = "SparkServicePlugin"

name

name: string = "Composite"

modelProperties

modelProperties: object

cleanupStartedAt

cleanupStartedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "cleanupStartedAt"

type

type: object

name

name: string = "DateTime"

currentState

currentState: object

serializedName

serializedName: string = "currentState"

type

type: object

name

name: string = "String"

monitoringStartedAt

monitoringStartedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "monitoringStartedAt"

type

type: object

name

name: string = "DateTime"

preparationStartedAt

preparationStartedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "preparationStartedAt"

type

type: object

name

name: string = "DateTime"

resourceAcquisitionStartedAt

resourceAcquisitionStartedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "resourceAcquisitionStartedAt"

type

type: object

name

name: string = "DateTime"

submissionStartedAt

submissionStartedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "submissionStartedAt"

type

type: object

name

name: string = "DateTime"

Const SparkSession

SparkSession: object

type

type: object

className

className: string = "SparkSession"

name

name: string = "Composite"

modelProperties

modelProperties: object

appId

appId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "appId"

type

type: object

name

name: string = "String"

appInfo

appInfo: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "appInfo"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

artifactId

artifactId: object

serializedName

serializedName: string = "artifactId"

type

type: object

name

name: string = "String"

errors

errors: object

serializedName

serializedName: string = "errorInfo"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SparkServiceError"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "Number"

jobType

jobType: object

serializedName

serializedName: string = "jobType"

type

type: object

name

name: string = "String"

livyInfo

livyInfo: object

serializedName

serializedName: string = "livyInfo"

type

type: object

className

className: string = "SparkSessionState"

name

name: string = "Composite"

logLines

logLines: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "log"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

plugin

plugin: object

serializedName

serializedName: string = "pluginInfo"

type

type: object

className

className: string = "SparkServicePlugin"

name

name: string = "Composite"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

name

name: string = "String"

scheduler

scheduler: object

serializedName

serializedName: string = "schedulerInfo"

type

type: object

className

className: string = "SparkScheduler"

name

name: string = "Composite"

sparkPoolName

sparkPoolName: object

serializedName

serializedName: string = "sparkPoolName"

type

type: object

name

name: string = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: string = "String"

submitterId

submitterId: object

serializedName

serializedName: string = "submitterId"

type

type: object

name

name: string = "String"

submitterName

submitterName: object

serializedName

serializedName: string = "submitterName"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

workspaceName

workspaceName: object

serializedName

serializedName: string = "workspaceName"

type

type: object

name

name: string = "String"

Const SparkSessionCollection

SparkSessionCollection: object

type

type: object

className

className: string = "SparkSessionCollection"

name

name: string = "Composite"

modelProperties

modelProperties: object

from

from: object

required

required: boolean = true

serializedName

serializedName: string = "from"

type

type: object

name

name: string = "Number"

sessions

sessions: object

serializedName

serializedName: string = "sessions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SparkSession"

name

name: string = "Composite"

total

total: object

required

required: boolean = true

serializedName

serializedName: string = "total"

type

type: object

name

name: string = "Number"

Const SparkSessionOptions

SparkSessionOptions: object

type

type: object

className

className: string = "SparkSessionOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

archives

archives: object

serializedName

serializedName: string = "archives"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

arguments

arguments: object

serializedName

serializedName: string = "args"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

artifactId

artifactId: object

serializedName

serializedName: string = "artifactId"

type

type: object

name

name: string = "String"

className

className: object

serializedName

serializedName: string = "className"

type

type: object

name

name: string = "String"

configuration

configuration: object

serializedName

serializedName: string = "conf"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

driverCores

driverCores: object

serializedName

serializedName: string = "driverCores"

type

type: object

name

name: string = "Number"

driverMemory

driverMemory: object

serializedName

serializedName: string = "driverMemory"

type

type: object

name

name: string = "String"

executorCores

executorCores: object

serializedName

serializedName: string = "executorCores"

type

type: object

name

name: string = "Number"

executorCount

executorCount: object

serializedName

serializedName: string = "numExecutors"

type

type: object

name

name: string = "Number"

executorMemory

executorMemory: object

serializedName

serializedName: string = "executorMemory"

type

type: object

name

name: string = "String"

file

file: object

serializedName

serializedName: string = "file"

type

type: object

name

name: string = "String"

files

files: object

serializedName

serializedName: string = "files"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

jars

jars: object

serializedName

serializedName: string = "jars"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

pythonFiles

pythonFiles: object

serializedName

serializedName: string = "pyFiles"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const SparkSessionState

SparkSessionState: object

type

type: object

className

className: string = "SparkSessionState"

name

name: string = "Composite"

modelProperties

modelProperties: object

busyAt

busyAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "busyAt"

type

type: object

name

name: string = "DateTime"

currentState

currentState: object

serializedName

serializedName: string = "currentState"

type

type: object

name

name: string = "String"

deadAt

deadAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "deadAt"

type

type: object

name

name: string = "DateTime"

errorAt

errorAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "errorAt"

type

type: object

name

name: string = "DateTime"

idleAt

idleAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "idleAt"

type

type: object

name

name: string = "DateTime"

jobCreationRequest

jobCreationRequest: object

serializedName

serializedName: string = "jobCreationRequest"

type

type: object

className

className: string = "SparkRequest"

name

name: string = "Composite"

notStartedAt

notStartedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "notStartedAt"

type

type: object

name

name: string = "DateTime"

recoveringAt

recoveringAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "recoveringAt"

type

type: object

name

name: string = "DateTime"

shuttingDownAt

shuttingDownAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "shuttingDownAt"

type

type: object

name

name: string = "DateTime"

startingAt

startingAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "startingAt"

type

type: object

name

name: string = "DateTime"

terminatedAt

terminatedAt: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "killedAt"

type

type: object

name

name: string = "DateTime"

Const SparkStatement

SparkStatement: object

type

type: object

className

className: string = "SparkStatement"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "Number"

output

output: object

serializedName

serializedName: string = "output"

type

type: object

className

className: string = "SparkStatementOutput"

name

name: string = "Composite"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: string = "String"

Const SparkStatementCancellationResult

SparkStatementCancellationResult: object

type

type: object

className

className: string = "SparkStatementCancellationResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "msg"

type

type: object

name

name: string = "String"

Const SparkStatementCollection

SparkStatementCollection: object

type

type: object

className

className: string = "SparkStatementCollection"

name

name: string = "Composite"

modelProperties

modelProperties: object

statements

statements: object

serializedName

serializedName: string = "statements"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SparkStatement"

name

name: string = "Composite"

total

total: object

required

required: boolean = true

serializedName

serializedName: string = "total_statements"

type

type: object

name

name: string = "Number"

Const SparkStatementOptions

SparkStatementOptions: object

type

type: object

className

className: string = "SparkStatementOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

kind

kind: object

serializedName

serializedName: string = "kind"

type

type: object

name

name: string = "String"

Const SparkStatementOutput

SparkStatementOutput: object

type

type: object

className

className: string = "SparkStatementOutput"

name

name: string = "Composite"

modelProperties

modelProperties: object

data

data: object

serializedName

serializedName: string = "data"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "any"

errorName

errorName: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "ename"

type

type: object

name

name: string = "String"

errorValue

errorValue: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "evalue"

type

type: object

name

name: string = "String"

executionCount

executionCount: object

required

required: boolean = true

serializedName

serializedName: string = "execution_count"

type

type: object

name

name: string = "Number"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

traceback

traceback: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "traceback"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const batchId

batchId: object

parameterPath

parameterPath: string = "batchId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "batchId"

type

type: object

name

name: string = "Number"

Const cancelSparkBatchJobOperationSpec

cancelSparkBatchJobOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches/{batchId}"

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.batchId]

responses

responses: object

200

200: {}

Type declaration

Const cancelSparkSessionOperationSpec

cancelSparkSessionOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}"

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.sessionId]

responses

responses: object

200

200: {}

Type declaration

Const cancelSparkStatementOperationSpec

cancelSparkStatementOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}/cancel"

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.sessionId,Parameters.statementId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkStatementCancellationResult

Const contentType

contentType: object

parameterPath

parameterPath: Object = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const createSparkBatchJobOperationSpec

createSparkBatchJobOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches"

queryParameters

queryParameters: Object = [Parameters.detailed]

requestBody

requestBody: any = Parameters.sparkBatchJobOptions

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkBatchJob

Const createSparkSessionOperationSpec

createSparkSessionOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions"

queryParameters

queryParameters: Object = [Parameters.detailed]

requestBody

requestBody: any = Parameters.sparkSessionOptions

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkSession

Const createSparkStatementOperationSpec

createSparkStatementOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements"

requestBody

requestBody: any = Parameters.sparkStatementOptions

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.sessionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkStatement

Const detailed

detailed: object

parameterPath

parameterPath: Object = ["options", "detailed"]

mapper

mapper: object

serializedName

serializedName: string = "detailed"

type

type: object

name

name: string = "Boolean"

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const fromParam

fromParam: object

parameterPath

parameterPath: Object = ["options", "fromParam"]

mapper

mapper: object

serializedName

serializedName: string = "from"

type

type: object

name

name: string = "Number"

Const getSparkBatchJobOperationSpec

getSparkBatchJobOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches/{batchId}"

queryParameters

queryParameters: Object = [Parameters.detailed]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.batchId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkBatchJob

Const getSparkBatchJobsOperationSpec

getSparkBatchJobsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches"

queryParameters

queryParameters: Object = [Parameters.fromParam, Parameters.size, Parameters.detailed]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkBatchJobCollection

Const getSparkSessionOperationSpec

getSparkSessionOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}"

queryParameters

queryParameters: Object = [Parameters.detailed]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.sessionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkSession

Const getSparkSessionsOperationSpec

getSparkSessionsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions"

queryParameters

queryParameters: Object = [Parameters.fromParam, Parameters.size, Parameters.detailed]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkSessionCollection

Const getSparkStatementOperationSpec

getSparkStatementOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}"

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.sessionId,Parameters.statementId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkStatement

Const getSparkStatementsOperationSpec

getSparkStatementsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements"

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.sessionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SparkStatementCollection

Const livyApiVersion

livyApiVersion: object

parameterPath

parameterPath: string = "livyApiVersion"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "livyApiVersion"

type

type: object

name

name: string = "String"

Const resetSparkSessionTimeoutOperationSpec

resetSparkSessionTimeoutOperationSpec: object

httpMethod

httpMethod: string = "PUT"

path

path: string = "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/reset-timeout"

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.livyApiVersion,Parameters.sparkPoolName,Parameters.sessionId]

responses

responses: object

200

200: {}

Type declaration

Const sessionId

sessionId: object

parameterPath

parameterPath: string = "sessionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "sessionId"

type

type: object

name

name: string = "Number"

Const size

size: object

parameterPath

parameterPath: Object = ["options", "size"]

mapper

mapper: object

serializedName

serializedName: string = "size"

type

type: object

name

name: string = "Number"

Const sparkBatchJobOptions

sparkBatchJobOptions: object

mapper

mapper: any = SparkBatchJobOptionsMapper

parameterPath

parameterPath: string = "sparkBatchJobOptions"

Const sparkPoolName

sparkPoolName: object

parameterPath

parameterPath: string = "sparkPoolName"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "sparkPoolName"

type

type: object

name

name: string = "String"

Const sparkSessionOptions

sparkSessionOptions: object

mapper

mapper: any = SparkSessionOptionsMapper

parameterPath

parameterPath: string = "sparkSessionOptions"

Const sparkStatementOptions

sparkStatementOptions: object

mapper

mapper: any = SparkStatementOptionsMapper

parameterPath

parameterPath: string = "sparkStatementOptions"

Const statementId

statementId: object

parameterPath

parameterPath: string = "statementId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "statementId"

type

type: object

name

name: string = "Number"

Generated using TypeDoc