Class: Job

Bulk~ Job

<protected> new Job(bulk, type, operation, options, jobId)

Class for Bulk API Job
Parameters:
Name Type Argument Description
bulk Bulk Bulk API object
type String <optional>
 SObject type
operation String <optional>
 Bulk load operation ('insert', 'update', 'upsert', 'delete', or 'hardDelete')
options Object <optional>
 Options for bulk loading operation
Properties
Name Type Argument Description
extIdField String <optional>
 External ID field name (used when upsert operation).
jobId String <optional>
 Job ID (if already available)
Source:

Extends

  • events.EventEmitter

Methods

abort(callback) → {Promise.<Bulk~JobInfo>}

Set the status to abort
Parameters:
Name Type Argument Description
callback Callback.<Bulk~JobInfo> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Bulk~JobInfo>

batch(batchId) → {Bulk~Batch}

Get a batch instance specified by given batch ID
Parameters:
Name Type Description
batchId String Batch ID
Source:
Returns:
Type
Bulk~Batch

check(callback) → {Promise.<Bulk~JobInfo>}

Check the job status from server
Parameters:
Name Type Argument Description
callback Callback.<Bulk~JobInfo> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Bulk~JobInfo>

close(callback) → {Promise.<Bulk~JobInfo>}

Close opened job
Parameters:
Name Type Argument Description
callback Callback.<Bulk~JobInfo> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Bulk~JobInfo>

createBatch() → {Bulk~Batch}

Create a new batch instance in the job
Source:
Returns:
Type
Bulk~Batch

list(callback) → {Promise.<Array.<Bulk~BatchInfo>>}

List all registered batch info in job
Parameters:
Name Type Argument Description
callback Callback.<Array.<Bulk~BatchInfo>> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Array.<Bulk~BatchInfo>>

open(callback) → {Promise.<Bulk~JobInfo>}

Open new job and get jobinfo
Parameters:
Name Type Argument Description
callback Callback.<Bulk~JobInfo> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Bulk~JobInfo>