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

Interface JobQueueRequest.Builder

Enclosing interface:
JobQueueRequest
public static interface JobQueueRequest.Builder
Builder interface for creating a JobQueueRequest instance.

  • Method Details

    • withJobName

      JobQueueRequest.Builder withJobName(String jobName)
      Sets the name of the job to be queued.
      Parameters:
      jobName - the name of the job
      Returns:
      the Builder instance

    • withJobTitle

      JobQueueRequest.Builder withJobTitle(String jobTitle)
      Sets the display title for the job.
      Parameters:
      jobTitle - the title to be displayed for the job
      Returns:
      the Builder instance

    • withJobRunTime

      JobQueueRequest.Builder withJobRunTime(ZonedDateTime startTime)
      Sets the specific time the job should run.
      Parameters:
      startTime - the desired start time for the job
      Returns:
      the Builder instance

    • withJobOwner

      JobQueueRequest.Builder withJobOwner(RequestContextUserType userType)
      Sets the user context under which the job will execute.
      Parameters:
      userType - the user type to own the job. For example, REQUEST_OWNER or INITIATING_USER.
      Returns:
      the Builder instance

    • withJobQueueParameters

      JobQueueRequest.Builder withJobQueueParameters(JobQueueParameters jobQueueParameters)
      Sets additional parameters.
      Parameters:
      jobQueueParameters - additional parameters
      Returns:
      the Builder instance

    • build

      JobQueueRequest build()
      Builds and retrieves the final JobQueueRequest object.
      Returns:
      a JobQueueRequest object