Class SparkBatchImpl

Package version

Class containing SparkBatch operations.

Hierarchy

SparkBatchImpl

Implements

SparkBatch

Index

Constructors

constructor

Methods

Constructors

constructor

new SparkBatchImpl(client: SparkClientContext): SparkBatchImpl

- Defined in operations/sparkBatch.ts:29
Initialize a new instance of the class SparkBatch class.

Parameters
- client: SparkClientContext
  
  Reference to the service client
Returns SparkBatchImpl

Methods

cancelSparkBatchJob

cancelSparkBatchJob(batchId: number, options?: SparkBatchCancelSparkBatchJobOptionalParams): Promise<void>

Implementation of SparkBatch.cancelSparkBatchJob
- Defined in operations/sparkBatch.ts:126
Cancels a running spark batch job.

Parameters
- batchId: number
  
  Identifier for the batch job.
- Optional options: SparkBatchCancelSparkBatchJobOptionalParams
  
  The options parameters.
Returns Promise<void>

createSparkBatchJob

createSparkBatchJob(sparkBatchJobOptions: SparkBatchJobOptions, options?: SparkBatchCreateSparkBatchJobOptionalParams): Promise<SparkBatchCreateSparkBatchJobResponse>

Implementation of SparkBatch.createSparkBatchJob
- Defined in operations/sparkBatch.ts:69
Create new spark batch job.

Parameters
- sparkBatchJobOptions: SparkBatchJobOptions
  
  Livy compatible batch job request payload.
- Optional options: SparkBatchCreateSparkBatchJobOptionalParams
  
  The options parameters.
Returns Promise<SparkBatchCreateSparkBatchJobResponse>

getSparkBatchJob

getSparkBatchJob(batchId: number, options?: SparkBatchGetSparkBatchJobOptionalParams): Promise<SparkBatchGetSparkBatchJobResponse>

Implementation of SparkBatch.getSparkBatchJob
- Defined in operations/sparkBatch.ts:99
Gets a single spark batch job.

Parameters
- batchId: number
  
  Identifier for the batch job.
- Optional options: SparkBatchGetSparkBatchJobOptionalParams
  
  The options parameters.
Returns Promise<SparkBatchGetSparkBatchJobResponse>

getSparkBatchJobs

getSparkBatchJobs(options?: SparkBatchGetSparkBatchJobsOptionalParams): Promise<SparkBatchGetSparkBatchJobsResponse>

Implementation of SparkBatch.getSparkBatchJobs
- Defined in operations/sparkBatch.ts:43
List all spark batch jobs which are running under a particular spark pool.

Parameters
- Optional options: SparkBatchGetSparkBatchJobsOptionalParams
  
  The options parameters.
Returns Promise<SparkBatchGetSparkBatchJobsResponse>

Generated using TypeDoc