com.springml.salesforce.wave.api

Interface BulkAPI

All Known Implementing Classes:

BulkAPIImpl

public interface BulkAPI

Java client for Salesforce Bulk API https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm

Method Summary

Modifier and Type	Method and Description
BatchInfo	addBatch(String jobId, String csvContent) Add a batch to an existing Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_add_batch.htm
JobInfo	closeJob(String jobId) Close the specified Salesforce Bulk Job
JobInfo	createJob(JobInfo jobInfo) Create a new Bulk Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_create_job.htm
JobInfo	createJob(JobInfo jobInfo, List<org.apache.http.Header> customHeaders) Create a new Bulk Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_create_job.htm
JobInfo	createJob(String object) Create a new Bulk Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_create_job.htm
JobInfo	createJob(String object, String operation, String contentType) Create a new Bulk Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_create_job.htm
BatchInfo	getBatchInfo(String jobId, String batchId) Provides details of the specified Batch
BatchInfoList	getBatchInfoList(String jobId) List of the Batches for the specified Job
String	getBatchResult(String jobId, String batchId, String resultId) Gets bulk query results
List<String>	getBatchResultIds(String jobId, String batchId) Retrieves a list of batch result IDs for a particular batch job.
boolean	isCompleted(String jobId) Queries Salesforce to get the BatchInfo of the specified Job Check whether all the Jobs are completed
boolean	isSuccess(String jobId) Queries Salesforce to get the BatchInfo of the specified Job Check whether all the Jobs are completed

Method Detail

createJob

JobInfo createJob(String object)
           throws Exception

Create a new Bulk Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_create_job.htm

Parameters:

The - Salesforce object to be updated

Returns:

@JobInfo

Throws:

Exception

createJob

JobInfo createJob(String object,
                  String operation,
                  String contentType)
           throws Exception

Create a new Bulk Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_create_job.htm

Parameters:

The - Salesforce object to be updated

Returns:

@JobInfo

Throws:

Exception

createJob

JobInfo createJob(JobInfo jobInfo)
           throws Exception

Create a new Bulk Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_create_job.htm

Parameters:

jobInfo - with details of the Job to be created

Returns:

JobInfo

Throws:

Exception

createJob

JobInfo createJob(JobInfo jobInfo,
                  List<org.apache.http.Header> customHeaders)
           throws Exception

Create a new Bulk Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_create_job.htm

Parameters:

jobInfo - with details of the Job to be created

customHeaders - Custom headers for job. These headers will be appended to default headers.

Returns:

JobInfo

Throws:

Exception

addBatch

BatchInfo addBatch(String jobId,
                   String csvContent)
            throws Exception

Add a batch to an existing Job https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart_add_batch.htm

Parameters:

jobId - Salesforce Job Id

csvContent - CSV Content which will be used to update salesforce objects

Returns:

BatchInfo

Throws:

Exception

closeJob

JobInfo closeJob(String jobId)
          throws Exception

Close the specified Salesforce Bulk Job

Parameters:

jobId - Job to be closed

Returns:

Throws:

Exception

isCompleted

boolean isCompleted(String jobId)
             throws Exception

Queries Salesforce to get the BatchInfo of the specified Job Check whether all the Jobs are completed

Parameters:

jobId - Job to be checked for its status

Returns:

true - if all batches are completed else false

Throws:

Exception

isSuccess

boolean isSuccess(String jobId)
           throws Exception

Queries Salesforce to get the BatchInfo of the specified Job Check whether all the Jobs are completed

Parameters:

jobId - Job to be checked for its status

Returns:

true - if all batches are completed else false

Throws:

Exception

getBatchInfoList

BatchInfoList getBatchInfoList(String jobId)
                        throws Exception

List of the Batches for the specified Job

Parameters:

jobId -

Returns:

Throws:

Exception

getBatchInfo

BatchInfo getBatchInfo(String jobId,
                       String batchId)
                throws Exception

Provides details of the specified Batch

Parameters:

jobId -

batchId -

Returns:

Throws:

Exception

getBatchResultIds

List<String> getBatchResultIds(String jobId,
                               String batchId)
                        throws Exception

Retrieves a list of batch result IDs for a particular batch job.

Parameters:

jobId - The identifier for the job

batchId - The batch identifier for the job

Returns:

Throws:

Exception

getBatchResult

String getBatchResult(String jobId,
                      String batchId,
                      String resultId)
               throws Exception

Gets bulk query results

Parameters:

jobId - The identifier for the job

batchId - The batch identifier for the job

resultId - the result ID in the response to the batch result list request

Returns:

Throws:

Exception