SparkBatch class
Class representing a SparkBatch.
Constructors
| Spark |
Create a SparkBatch. |
Methods
Constructor Details
SparkBatch(SynapseClientContext)
Create a SparkBatch.
new SparkBatch(client: SynapseClientContext)Parameters
- client
- SynapseClientContext
Reference to the service client.
Method Details
create(string, string, ExtendedLivyBatchRequest, ServiceCallback<ExtendedLivyBatchResponse>)
function create(workspaceName: string, sparkPoolName: string, livyRequest: ExtendedLivyBatchRequest, callback: ServiceCallback<ExtendedLivyBatchResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- livyRequest
- ExtendedLivyBatchRequest
Livy compatible batch job request payload.
- callback
The callback
create(string, string, ExtendedLivyBatchRequest, SparkBatchCreateOptionalParams)
Create new spark batch job.
function create(workspaceName: string, sparkPoolName: string, livyRequest: ExtendedLivyBatchRequest, options?: SparkBatchCreateOptionalParams): Promise<SparkBatchCreateResponse>Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- livyRequest
- ExtendedLivyBatchRequest
Livy compatible batch job request payload.
- options
- SparkBatchCreateOptionalParams
The optional parameters
Returns
Promise<SparkBatchCreateResponse>
Promise<Models.SparkBatchCreateResponse>
create(string, string, ExtendedLivyBatchRequest, SparkBatchCreateOptionalParams, ServiceCallback<ExtendedLivyBatchResponse>)
function create(workspaceName: string, sparkPoolName: string, livyRequest: ExtendedLivyBatchRequest, options: SparkBatchCreateOptionalParams, callback: ServiceCallback<ExtendedLivyBatchResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- livyRequest
- ExtendedLivyBatchRequest
Livy compatible batch job request payload.
- options
- SparkBatchCreateOptionalParams
The optional parameters
- callback
The callback
deleteMethod(string, string, number, RequestOptionsBase)
Cancels a running spark batch job.
function deleteMethod(workspaceName: string, sparkPoolName: string, batchId: number, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- batchId
-
number
Identifier for the batch job.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, number, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(workspaceName: string, sparkPoolName: string, batchId: number, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- batchId
-
number
Identifier for the batch job.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, number, ServiceCallback<void>)
function deleteMethod(workspaceName: string, sparkPoolName: string, batchId: number, callback: ServiceCallback<void>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- batchId
-
number
Identifier for the batch job.
- callback
-
ServiceCallback<void>
The callback
get(string, string, number, ServiceCallback<ExtendedLivyBatchResponse>)
function get(workspaceName: string, sparkPoolName: string, batchId: number, callback: ServiceCallback<ExtendedLivyBatchResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- batchId
-
number
Identifier for the batch job.
- callback
The callback
get(string, string, number, SparkBatchGetOptionalParams)
Gets a single spark batch job.
function get(workspaceName: string, sparkPoolName: string, batchId: number, options?: SparkBatchGetOptionalParams): Promise<SparkBatchGetResponse>Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- batchId
-
number
Identifier for the batch job.
- options
- SparkBatchGetOptionalParams
The optional parameters
Returns
Promise<SparkBatchGetResponse>
Promise<Models.SparkBatchGetResponse>
get(string, string, number, SparkBatchGetOptionalParams, ServiceCallback<ExtendedLivyBatchResponse>)
function get(workspaceName: string, sparkPoolName: string, batchId: number, options: SparkBatchGetOptionalParams, callback: ServiceCallback<ExtendedLivyBatchResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- batchId
-
number
Identifier for the batch job.
- options
- SparkBatchGetOptionalParams
The optional parameters
- callback
The callback
list(string, string, ServiceCallback<ExtendedLivyListBatchResponse>)
function list(workspaceName: string, sparkPoolName: string, callback: ServiceCallback<ExtendedLivyListBatchResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- callback
The callback
list(string, string, SparkBatchListOptionalParams)
List all spark batch jobs which are running under a particular spark pool.
function list(workspaceName: string, sparkPoolName: string, options?: SparkBatchListOptionalParams): Promise<SparkBatchListResponse>Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- options
- SparkBatchListOptionalParams
The optional parameters
Returns
Promise<SparkBatchListResponse>
Promise<Models.SparkBatchListResponse>
list(string, string, SparkBatchListOptionalParams, ServiceCallback<ExtendedLivyListBatchResponse>)
function list(workspaceName: string, sparkPoolName: string, options: SparkBatchListOptionalParams, callback: ServiceCallback<ExtendedLivyListBatchResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- sparkPoolName
-
string
Name of the spark pool. "ondemand" targets the ondemand pool.
- options
- SparkBatchListOptionalParams
The optional parameters
- callback
The callback