Class SparkBatch

Package version

Class representing a SparkBatch.

Hierarchy

SparkBatch

Index

Constructors

constructor

Methods

Constructors

constructor

new SparkBatch(client: SparkClient): SparkBatch

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

Parameters
- client: SparkClient
  
  Reference to the service client
Returns SparkBatch

Methods

cancelSparkBatchJob

cancelSparkBatchJob(batchId: number, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in operations/sparkBatch.ts:135
Cancels a running spark batch job.

Parameters
- batchId: number
  
  Identifier for the batch job.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

createSparkBatchJob

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

- Defined in operations/sparkBatch.ts:67
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>

- Defined in operations/sparkBatch.ts:101
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>

- Defined in operations/sparkBatch.ts:35
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