node-sf-bulk2
Preparing search index...
BulkAPI2
Class BulkAPI2
Index
Constructors
constructor
Methods
abort
Bulk
Query
Job
close
Or
Abort
Job
create
Data
Upload
Job
create
Data
Upload
Job
With
Data
delete
Bulk
Query
Job
delete
Ingest
Job
get
All
Bulk
Query
Job
Info
get
All
Ingest
Job
Info
get
Bulk
Query
Job
Info
get
Bulk
Query
Result
Pages
get
Bulk
Query
Results
get
Bulk
Query
Results
Stream
get
Ingest
Job
Info
get
Results
submit
Bulk
Query
Job
upload
Job
Data
Constructors
constructor
new
BulkAPI2
(
connection
:
BulkAPI2Connection
)
:
BulkAPI2
Parameters
connection
:
BulkAPI2Connection
Returns
BulkAPI2
Methods
abort
Bulk
Query
Job
abortBulkQueryJob
(
jobId
:
string
)
:
Promise
<
BulkQueryResponse
>
Parameters
jobId
:
string
Returns
Promise
<
BulkQueryResponse
>
close
Or
Abort
Job
closeOrAbortJob
(
jobId
:
string
,
state
:
string
)
:
Promise
<
JobUploadResponse
>
Parameters
jobId
:
string
state
:
string
Returns
Promise
<
JobUploadResponse
>
create
Data
Upload
Job
createDataUploadJob
(
jobUploadRequest
:
JobUploadRequest
,
)
:
Promise
<
JobUploadResponse
>
Parameters
jobUploadRequest
:
JobUploadRequest
Returns
Promise
<
JobUploadResponse
>
create
Data
Upload
Job
With
Data
createDataUploadJobWithData
(
jobUploadRequest
:
JobUploadRequest
,
csvData
:
string
,
)
:
Promise
<
JobUploadResponse
>
Parameters
jobUploadRequest
:
JobUploadRequest
csvData
:
string
Returns
Promise
<
JobUploadResponse
>
delete
Bulk
Query
Job
deleteBulkQueryJob
(
jobId
:
string
)
:
Promise
<
void
>
Parameters
jobId
:
string
Returns
Promise
<
void
>
delete
Ingest
Job
deleteIngestJob
(
jobId
:
string
)
:
Promise
<
void
>
Parameters
jobId
:
string
Returns
Promise
<
void
>
get
All
Bulk
Query
Job
Info
getAllBulkQueryJobInfo
(
configInput
?:
BulkQueryConfig
,
)
:
Promise
<
AllBulkQueryJobsInfoResponse
>
Parameters
Optional
configInput
:
BulkQueryConfig
Returns
Promise
<
AllBulkQueryJobsInfoResponse
>
get
All
Ingest
Job
Info
getAllIngestJobInfo
(
configInput
?:
IngestJobConfig
,
)
:
Promise
<
AllIngestJobsInfoResponse
>
Parameters
Optional
configInput
:
IngestJobConfig
Returns
Promise
<
AllIngestJobsInfoResponse
>
get
Bulk
Query
Job
Info
getBulkQueryJobInfo
(
jobId
:
string
)
:
Promise
<
BulkJobInfoResponse
>
Parameters
jobId
:
string
Returns
Promise
<
BulkJobInfoResponse
>
get
Bulk
Query
Result
Pages
getBulkQueryResultPages
(
jobId
:
string
)
:
Promise
<
ParallelQueryResultsResponse
>
Parameters
jobId
:
string
Returns
Promise
<
ParallelQueryResultsResponse
>
get
Bulk
Query
Results
getBulkQueryResults
(
jobId
:
string
,
locator
?:
string
,
maxRecords
?:
number
,
)
:
Promise
<
AxiosResponse
<
any
,
any
,
{}
>
>
Parameters
jobId
:
string
Optional
locator
:
string
Optional
maxRecords
:
number
Returns
Promise
<
AxiosResponse
<
any
,
any
,
{}
>
>
get
Bulk
Query
Results
Stream
getBulkQueryResultsStream
(
jobId
:
string
,
locator
?:
string
,
maxRecords
?:
number
,
)
:
Promise
<
Readable
>
Parameters
jobId
:
string
Optional
locator
:
string
Optional
maxRecords
:
number
Returns
Promise
<
Readable
>
get
Ingest
Job
Info
getIngestJobInfo
(
jobId
:
string
)
:
Promise
<
JobInfoResponse
>
Parameters
jobId
:
string
Returns
Promise
<
JobInfoResponse
>
get
Results
getResults
(
jobId
:
string
,
resulttype
:
RESULTTYPE
)
:
Promise
<
string
>
Parameters
jobId
:
string
resulttype
:
RESULTTYPE
Returns
Promise
<
string
>
submit
Bulk
Query
Job
submitBulkQueryJob
(
query
:
QueryInput
)
:
Promise
<
BulkQueryResponse
>
Parameters
query
:
QueryInput
Returns
Promise
<
BulkQueryResponse
>
upload
Job
Data
uploadJobData
(
contenturl
:
string
,
data
:
string
)
:
Promise
<
number
>
Parameters
contenturl
:
string
data
:
string
Returns
Promise
<
number
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
abort
Bulk
Query
Job
close
Or
Abort
Job
create
Data
Upload
Job
create
Data
Upload
Job
With
Data
delete
Bulk
Query
Job
delete
Ingest
Job
get
All
Bulk
Query
Job
Info
get
All
Ingest
Job
Info
get
Bulk
Query
Job
Info
get
Bulk
Query
Result
Pages
get
Bulk
Query
Results
get
Bulk
Query
Results
Stream
get
Ingest
Job
Info
get
Results
submit
Bulk
Query
Job
upload
Job
Data
node-sf-bulk2
Loading...