Class BulkAPI2

Hierarchy

BulkAPI2

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BulkAPI2(connection: BulkAPI2Connection): BulkAPI2

- Defined in bulk2.ts:16
Parameters
- connection: BulkAPI2Connection
Returns BulkAPI2

Properties

Private connection

connection: BulkAPI2Connection

Private endpoint

endpoint: string

Methods

abortbulkQueryJob

abortbulkQueryJob(jobId: string): Promise<BulkQueryResponse>

- Defined in bulk2.ts:76
Parameters
- jobId: string
Returns Promise<BulkQueryResponse>

closeOrAbortJob

closeOrAbortJob(jobId: string, state: string): Promise<JobUploadResponse>

- Defined in bulk2.ts:120
Parameters
- jobId: string
- state: string
Returns Promise<JobUploadResponse>

createDataUploadJob

createDataUploadJob(jobUploadRequest: JobUploadRequest): Promise<JobUploadResponse>

- Defined in bulk2.ts:105
Parameters
- jobUploadRequest: JobUploadRequest
Returns Promise<JobUploadResponse>

getAllBulkQueryJobInfo

getAllBulkQueryJobInfo(configInput?: BulkQueryConfig): Promise<AllBulkQueryJobsInfoResponse>

- Defined in bulk2.ts:56
Parameters
- Optional configInput: BulkQueryConfig
Returns Promise<AllBulkQueryJobsInfoResponse>

getBulkQueryJobInfo

getBulkQueryJobInfo(jobId: string): Promise<BulkJobInfoResponse>

- Defined in bulk2.ts:48
Parameters
- jobId: string
Returns Promise<BulkJobInfoResponse>

getBulkqueryResults

getBulkqueryResults(jobId: string, locator?: number, maxRecords?: number): Promise<string>

- Defined in bulk2.ts:87
Parameters
- jobId: string
- Optional locator: number
- Optional maxRecords: number
Returns Promise<string>

getIngestJobInfo

getIngestJobInfo(jobId: string): Promise<JobInfoResponse>

- Defined in bulk2.ts:131
Parameters
- jobId: string
Returns Promise<JobInfoResponse>

Private getRequestConfig

getRequestConfig(contentType: string, accept?: string): AxiosRequestConfig

- Defined in bulk2.ts:27
Parameters
- contentType: string
- Optional accept: string
Returns AxiosRequestConfig

getResults

getResults(jobId: string, resulttype: RESULTTYPE): Promise<string>

- Defined in bulk2.ts:139
Parameters
- jobId: string
- resulttype: RESULTTYPE
Returns Promise<string>

submitBulkQueryJob

submitBulkQueryJob(query: QueryInput): Promise<BulkQueryResponse>

- Defined in bulk2.ts:39
Parameters
- query: QueryInput
Returns Promise<BulkQueryResponse>

uploadJobData

uploadJobData(contenturl: string, data: string): Promise<number>

- Defined in bulk2.ts:113
Parameters
- contenturl: string
- data: string
Returns Promise<number>

Generated using TypeDoc