com.veeva.vault.vapil.api.request

Class LoaderRequest

java.lang.Object

com.veeva.vault.vapil.api.request.VaultRequest

com.veeva.vault.vapil.api.request.LoaderRequest

public class LoaderRequest
extends VaultRequest

Vault Loader Requests

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#vault-loader

Field Summary

Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest

HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_VAULT_CLIENT_ID, vaultClient

Method Summary

Modifier and Type	Method and Description
LoaderRequest	addLoaderTask(LoaderTask loaderTask) Add an individual Vault Loader Task to the request Throws IllegalArgumentException when maximum number of loader tasks is reached (10).
LoaderRequest	addLoaderTasks(List<LoaderTask> loaderTasks) Add a full list of Vault Loader Tasks to the request Throws IllegalArgumentException when maximum number of loader tasks is reached (10).
LoaderResponse	extractDataFiles() Extract Data Files
LoaderResponse	loadDataObjects() Load Data Objects
VaultResponse	retrieveExtractRenditionResults(int jobId, int taskId) Retrieve Loader Extract Renditions Results
VaultResponse	retrieveExtractResults(int jobId, int taskId) Retrieve Extract Results
VaultResponse	retrieveLoadFailureLogResults(int jobId, int taskId) Retrieve Load Success Log Results
VaultResponse	retrieveLoadSuccessLogResults(int jobId, int taskId) Retrieve Load Success Log Results
LoaderRequest	setJson(String json) Set a raw JSON string to the Vault Loader request
LoaderRequest	setOutputPath(String outputPath) Specify source data in an output file
LoaderRequest	setSendNotification(Boolean sendNotification) To send a Vault notification when the job completes, set to true.

Methods inherited from class com.veeva.vault.vapil.api.request.VaultRequest

getBaseObjectMapper, send, send, sendReturnBinary, sendReturnBinary, sendToFile, sendToFile, setVaultClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

extractDataFiles

public LoaderResponse extractDataFiles()

Extract Data Files

Returns:

LoaderResponse

Vault API Endpoint:

 POST /api/{version}/services/loader/extract

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#extract-data-files

loadDataObjects

public LoaderResponse loadDataObjects()

Load Data Objects

Returns:

LoaderResponse

Vault API Endpoint:

 POST /api/{version}/services/loader/load
 

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#load-data-objects

retrieveExtractResults

public VaultResponse retrieveExtractResults(int jobId,
                                            int taskId)

Retrieve Extract Results

Parameters:

jobId - The Job Id

taskId - The Task Id

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/services/loader/{job_id}/tasks/{task_id}/results

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-extract-results

retrieveExtractRenditionResults

public VaultResponse retrieveExtractRenditionResults(int jobId,
                                                     int taskId)

Retrieve Loader Extract Renditions Results

Parameters:

jobId - The Job Id

taskId - The Task Id

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/services/loader/{job_id}/tasks/{task_id}/results/renditions

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-loader-extract-renditions-results

retrieveLoadSuccessLogResults

public VaultResponse retrieveLoadSuccessLogResults(int jobId,
                                                   int taskId)

Retrieve Load Success Log Results

Parameters:

jobId - The Job Id

taskId - The Task Id

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/services/loader/{job_id}/tasks/{task_id}/successlog

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-load-success-log-results

retrieveLoadFailureLogResults

public VaultResponse retrieveLoadFailureLogResults(int jobId,
                                                   int taskId)

Retrieve Load Success Log Results

Parameters:

jobId - The Job Id

taskId - The Task Id

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/services/loader/{job_id}/tasks/{task_id}/failurelog

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-load-failure-log-results

setJson

public LoaderRequest setJson(String json)

Set a raw JSON string to the Vault Loader request

Parameters:

json - Fully formed Vault Loader request

Returns:

The Request

addLoaderTask

public LoaderRequest addLoaderTask(LoaderTask loaderTask)
                            throws Exception

Add an individual Vault Loader Task to the request Throws IllegalArgumentException when maximum number of loader tasks is reached (10).

Parameters:

loaderTask - The Vault Loader Task to add

Returns:

The Request

Throws:

Exception - The exception

addLoaderTasks

public LoaderRequest addLoaderTasks(List<LoaderTask> loaderTasks)
                             throws Exception

Add a full list of Vault Loader Tasks to the request Throws IllegalArgumentException when maximum number of loader tasks is reached (10).

Parameters:

loaderTasks - The Vault Loader Task to add

Returns:

The Request

Throws:

Exception - maximum number of loader tasks exceeded

setOutputPath

public LoaderRequest setOutputPath(String outputPath)

Specify source data in an output file

Parameters:

outputPath - Absolute path to the file for the response

Returns:

The Request

setSendNotification

public LoaderRequest setSendNotification(Boolean sendNotification)

To send a Vault notification when the job completes, set to true. If omitted, this defaults to false and Vault does not send a notification when the job completes.

Parameters:

sendNotification - send notification to user

Returns:

The Request