Package com.veeva.vault.sdk.api.job

Interface JobService

All Superinterfaces:

Service

public interface JobService
extends Service

Service interface to run jobs with specified parameters.

Method Summary

Modifier and Type	Method	Description
JobCancelOperation<JobCancelResponse>	cancel(JobCancelRequest jobCancelRequest)	Cancels one currently running job entry.
JobCancelRequest.Builder	newCancelJobRequestBuilder()	Creates a new JobCancelRequest.Builder.
JobParameters	newJobParameters(String jobName)	Retrieves a new JobParameters object for a specific job to set the parameters of the job.
void	run(JobParameters jobParameters)	Runs a job as specified in a JobParameters object.
JobRunResult	runJob(JobParameters jobParameters)	Runs a job as specified in a JobParameters object, and also returns a JobRunResult object.

Method Details

newJobParameters

JobParameters newJobParameters(String jobName)

Retrieves a new JobParameters object for a specific job to set the parameters of the job.

For example, the value record_user_action__v would be used to create job parameters for the job that will run a user action for a collection of Vault records.

Parameters:

jobName - name of a Vault job

Returns:

a JobParameters object for setting parameters for the specified job

run

void run(JobParameters jobParameters)

Runs a job as specified in a JobParameters object.

Job parameters should be set by using JobParameters.setValue(String, Object) before running a job.

Parameters:

jobParameters - a JobParameters object that contains the job name and parameters

runJob

JobRunResult runJob(JobParameters jobParameters)

Runs a job as specified in a JobParameters object, and also returns a JobRunResult object.

Job parameters should be set by using JobParameters.setValue(String, Object) before running a job.

Parameters:

jobParameters - a JobParameters object that contains the job name and parameters

Returns:

JobRunResult object, which allows you to obtain the job ID

newCancelJobRequestBuilder

JobCancelRequest.Builder newCancelJobRequestBuilder()

Creates a new JobCancelRequest.Builder.

Returns:

a new JobCancelRequest.Builder

cancel

JobCancelOperation<JobCancelResponse> cancel(JobCancelRequest jobCancelRequest)

Cancels one currently running job entry. In the process, skips all job tasks that have not yet completed. Executes Job.completeWithError(JobCompletionContext) on completion. Cancelled tasks will have TaskState.FAILED_TO_RUN. This operation cannot be rolled back.

Parameters:

jobCancelRequest - jobInstanceId of the job instance to cancel