Class BulkAPI2

Index

Constructors

Methods

abortBulkQueryJob closeOrAbortJob createDataUploadJob createDataUploadJobWithData deleteBulkQueryJob deleteIngestJob getAllBulkQueryJobInfo getAllIngestJobInfo getBulkQueryJobInfo getBulkQueryResultPages getBulkQueryResults getBulkQueryResultsStream getIngestJobInfo getResults submitBulkQueryJob uploadJobData

Constructors

constructor

new BulkAPI2(connection: BulkAPI2Connection): BulkAPI2
Parameters
- connection: BulkAPI2Connection
Returns BulkAPI2
- Defined in bulk2.ts:22

Methods

abortBulkQueryJob

abortBulkQueryJob(jobId: string): Promise<BulkQueryResponse>
Parameters
- jobId: string
Returns Promise<BulkQueryResponse>
- Defined in bulk2.ts:94

closeOrAbortJob

closeOrAbortJob(jobId: string, state: string): Promise<JobUploadResponse>
Parameters
- jobId: string
- state: string
Returns Promise<JobUploadResponse>
- Defined in bulk2.ts:155

createDataUploadJob

createDataUploadJob(
jobUploadRequest: JobUploadRequest,
): Promise<JobUploadResponse>
Parameters
- jobUploadRequest: JobUploadRequest
Returns Promise<JobUploadResponse>
- Defined in bulk2.ts:140

createDataUploadJobWithData

createDataUploadJobWithData(
jobUploadRequest: JobUploadRequest,
csvData: string,
): Promise<JobUploadResponse>
Parameters
- jobUploadRequest: JobUploadRequest
- csvData: string
Returns Promise<JobUploadResponse>
- Defined in bulk2.ts:221

deleteBulkQueryJob

deleteBulkQueryJob(jobId: string): Promise<void>
Parameters
- jobId: string
Returns Promise<void>
- Defined in bulk2.ts:187

deleteIngestJob

deleteIngestJob(jobId: string): Promise<void>
Parameters
- jobId: string
Returns Promise<void>
- Defined in bulk2.ts:181

getAllBulkQueryJobInfo

getAllBulkQueryJobInfo(
configInput?: BulkQueryConfig,
): Promise<AllBulkQueryJobsInfoResponse>
Parameters
- OptionalconfigInput: BulkQueryConfig
Returns Promise<AllBulkQueryJobsInfoResponse>
- Defined in bulk2.ts:74

getAllIngestJobInfo

getAllIngestJobInfo(
configInput?: IngestJobConfig,
): Promise<AllIngestJobsInfoResponse>
Parameters
- OptionalconfigInput: IngestJobConfig
Returns Promise<AllIngestJobsInfoResponse>
- Defined in bulk2.ts:193

getBulkQueryJobInfo

getBulkQueryJobInfo(jobId: string): Promise<BulkJobInfoResponse>
Parameters
- jobId: string
Returns Promise<BulkJobInfoResponse>
- Defined in bulk2.ts:66

getBulkQueryResultPages

getBulkQueryResultPages(jobId: string): Promise<ParallelQueryResultsResponse>
Parameters
- jobId: string
Returns Promise<ParallelQueryResultsResponse>
- Defined in bulk2.ts:213

getBulkQueryResults

getBulkQueryResults(
    jobId: string,
    locator?: string,
    maxRecords?: number,
): Promise<AxiosResponse<any, any, {}>>
Parameters
- jobId: string
- Optionallocator: string
- OptionalmaxRecords: number
Returns Promise<AxiosResponse<any, any, {}>>
- Defined in bulk2.ts:105

getBulkQueryResultsStream

getBulkQueryResultsStream(
    jobId: string,
    locator?: string,
    maxRecords?: number,
): Promise<Readable>
Parameters
- jobId: string
- Optionallocator: string
- OptionalmaxRecords: number
Returns Promise<Readable>
- Defined in bulk2.ts:122

getIngestJobInfo

getIngestJobInfo(jobId: string): Promise<JobInfoResponse>
Parameters
- jobId: string
Returns Promise<JobInfoResponse>
- Defined in bulk2.ts:166

getResults

getResults(jobId: string, resulttype: RESULTTYPE): Promise<string>
Parameters
- jobId: string
- resulttype: RESULTTYPE
Returns Promise<string>
- Defined in bulk2.ts:174

submitBulkQueryJob

submitBulkQueryJob(query: QueryInput): Promise<BulkQueryResponse>
Parameters
- query: QueryInput
Returns Promise<BulkQueryResponse>
- Defined in bulk2.ts:57

uploadJobData

uploadJobData(contenturl: string, data: string): Promise<number>
Parameters
- contenturl: string
- data: string
Returns Promise<number>
- Defined in bulk2.ts:148