Interface SparkSessionOperations

Package version

Interface representing a SparkSessionOperations.

Hierarchy

SparkSessionOperations

Implemented by

SparkSessionOperationsImpl

Index

Methods

Methods

cancelSparkSession

cancelSparkSession(sessionId: number, options?: SparkSessionOperationsCancelSparkSessionOptionalParams): Promise<void>

- Defined in operationsInterfaces/sparkSessionOperations.ts:62
Cancels a running spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- Optional options: SparkSessionOperationsCancelSparkSessionOptionalParams
  
  The options parameters.
Returns Promise<void>

cancelSparkStatement

cancelSparkStatement(sessionId: number, statementId: number, options?: SparkSessionOperationsCancelSparkStatementOptionalParams): Promise<SparkSessionOperationsCancelSparkStatementResponse>

- Defined in operationsInterfaces/sparkSessionOperations.ts:112
Kill a statement within a session.

Parameters
- sessionId: number
  
  Identifier for the session.
- statementId: number
  
  Identifier for the statement.
- Optional options: SparkSessionOperationsCancelSparkStatementOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionOperationsCancelSparkStatementResponse>

createSparkSession

createSparkSession(sparkSessionOptions: SparkSessionOptions, options?: SparkSessionOperationsCreateSparkSessionOptionalParams): Promise<SparkSessionOperationsCreateSparkSessionResponse>

- Defined in operationsInterfaces/sparkSessionOperations.ts:44
Create new spark session.

Parameters
- sparkSessionOptions: SparkSessionOptions
  
  Livy compatible batch job request payload.
- Optional options: SparkSessionOperationsCreateSparkSessionOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionOperationsCreateSparkSessionResponse>

createSparkStatement

createSparkStatement(sessionId: number, sparkStatementOptions: SparkStatementOptions, options?: SparkSessionOperationsCreateSparkStatementOptionalParams): Promise<SparkSessionOperationsCreateSparkStatementResponse>

- Defined in operationsInterfaces/sparkSessionOperations.ts:90
Create statement within a spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- sparkStatementOptions: SparkStatementOptions
  
  Livy compatible batch job request payload.
- Optional options: SparkSessionOperationsCreateSparkStatementOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionOperationsCreateSparkStatementResponse>

getSparkSession

getSparkSession(sessionId: number, options?: SparkSessionOperationsGetSparkSessionOptionalParams): Promise<SparkSessionOperationsGetSparkSessionResponse>

- Defined in operationsInterfaces/sparkSessionOperations.ts:53
Gets a single spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- Optional options: SparkSessionOperationsGetSparkSessionOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionOperationsGetSparkSessionResponse>

getSparkSessions

getSparkSessions(options?: SparkSessionOperationsGetSparkSessionsOptionalParams): Promise<SparkSessionOperationsGetSparkSessionsResponse>

- Defined in operationsInterfaces/sparkSessionOperations.ts:36
List all spark sessions which are running under a particular spark pool.

Parameters
- Optional options: SparkSessionOperationsGetSparkSessionsOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionOperationsGetSparkSessionsResponse>

getSparkStatement

getSparkStatement(sessionId: number, statementId: number, options?: SparkSessionOperationsGetSparkStatementOptionalParams): Promise<SparkSessionOperationsGetSparkStatementResponse>

- Defined in operationsInterfaces/sparkSessionOperations.ts:101
Gets a single statement within a spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- statementId: number
  
  Identifier for the statement.
- Optional options: SparkSessionOperationsGetSparkStatementOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionOperationsGetSparkStatementResponse>

getSparkStatements

getSparkStatements(sessionId: number, options?: SparkSessionOperationsGetSparkStatementsOptionalParams): Promise<SparkSessionOperationsGetSparkStatementsResponse>

- Defined in operationsInterfaces/sparkSessionOperations.ts:80
Gets a list of statements within a spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- Optional options: SparkSessionOperationsGetSparkStatementsOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionOperationsGetSparkStatementsResponse>

resetSparkSessionTimeout

resetSparkSessionTimeout(sessionId: number, options?: SparkSessionOperationsResetSparkSessionTimeoutOptionalParams): Promise<void>

- Defined in operationsInterfaces/sparkSessionOperations.ts:71
Sends a keep alive call to the current session to reset the session timeout.

Parameters
- sessionId: number
  
  Identifier for the session.
- Optional options: SparkSessionOperationsResetSparkSessionTimeoutOptionalParams
  
  The options parameters.
Returns Promise<void>

Generated using TypeDoc