com.revo.deployr.client.api

Interface RUserJobCalls

All Known Subinterfaces:

RUser

public interface RUserJobCalls

Defines job related interfaces for DeployR-managed user.

Method Summary

Modifier and Type	Method and Description
java.util.List<RJob>	listJobs() List jobs.
RJob	queryJob(java.lang.String job) Query an existing job by job identifier.
RJob	submitJobCode(java.lang.String jobName, java.lang.String jobDescr, java.lang.String code) Submit job based on block of R code.
RJob	submitJobCode(java.lang.String jobName, java.lang.String jobDescr, java.lang.String code, JobExecutionOptions options) Submit job based on block of R code.
RJob	submitJobExternal(java.lang.String jobName, java.lang.String jobDescr, java.lang.String externalSource, JobExecutionOptions options) Submit a single script found on a URL/path or a chain of scripts found on a set of URLs/paths on the current project.
RJob	submitJobScript(java.lang.String jobName, java.lang.String jobDescr, java.lang.String scriptName, java.lang.String scriptAuthor, java.lang.String scriptVersion) Deprecated. As of release 7.1, use submitJobScript method that supports scriptDirectory parameter. This deprecated call assumes each script is found in the root directory.
RJob	submitJobScript(java.lang.String jobName, java.lang.String jobDescr, java.lang.String scriptName, java.lang.String scriptAuthor, java.lang.String scriptVersion, JobExecutionOptions options) Deprecated. As of release 7.1, use submitJobScript method that supports scriptDirectory parameter. This deprecated call assumes each script is found in the root directory.
RJob	submitJobScript(java.lang.String jobName, java.lang.String jobDescr, java.lang.String scriptName, java.lang.String scriptDirectory, java.lang.String scriptAuthor, java.lang.String scriptVersion) Submit a single repository-managed script or a chain of repository-managed scripts to execute as a job.
RJob	submitJobScript(java.lang.String jobName, java.lang.String jobDescr, java.lang.String scriptName, java.lang.String scriptDirectory, java.lang.String scriptAuthor, java.lang.String scriptVersion, JobExecutionOptions options) Submit a single repository-managed script or a chain of repository-managed scripts to execute as a job.

Method Detail

listJobs

java.util.List<RJob> listJobs()
                       throws RClientException,
                              RSecurityException

List jobs.

Returns:

List<RJob>

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

queryJob

RJob queryJob(java.lang.String job)
       throws RClientException,
              RSecurityException

Query an existing job by job identifier.

Returns:

RJob

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

submitJobCode

RJob submitJobCode(java.lang.String jobName,
                   java.lang.String jobDescr,
                   java.lang.String code)
            throws RClientException,
                   RSecurityException,
                   RDataException

Submit job based on block of R code.

Returns:

RJob

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

submitJobCode

RJob submitJobCode(java.lang.String jobName,
                   java.lang.String jobDescr,
                   java.lang.String code,
                   JobExecutionOptions options)
            throws RClientException,
                   RSecurityException,
                   RDataException

Submit job based on block of R code.

Returns:

RJob

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

submitJobScript

@Deprecated
RJob submitJobScript(java.lang.String jobName,
                                 java.lang.String jobDescr,
                                 java.lang.String scriptName,
                                 java.lang.String scriptAuthor,
                                 java.lang.String scriptVersion)
                          throws RClientException,
                                 RSecurityException,
                                 RDataException

Deprecated. As of release 7.1, use submitJobScript method that supports scriptDirectory parameter. This deprecated call assumes each script is found in the root directory.

Submit a single repository-managed script or a chain of repository-managed scripts (found in the root directory) to execute as a job.

To submit a chain of repository-managed scripts on this call provide a comma-separated list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

Returns:

RJob

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

submitJobScript

@Deprecated
RJob submitJobScript(java.lang.String jobName,
                                 java.lang.String jobDescr,
                                 java.lang.String scriptName,
                                 java.lang.String scriptAuthor,
                                 java.lang.String scriptVersion,
                                 JobExecutionOptions options)
                          throws RClientException,
                                 RSecurityException,
                                 RDataException

Deprecated. As of release 7.1, use submitJobScript method that supports scriptDirectory parameter. This deprecated call assumes each script is found in the root directory.

Submit a single repository-managed script or a chain of repository-managed scripts to execute as a job.

To submit a chain of repository-managed scripts on this call provide a comma-separated list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

Returns:

RJob

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

submitJobScript

RJob submitJobScript(java.lang.String jobName,
                     java.lang.String jobDescr,
                     java.lang.String scriptName,
                     java.lang.String scriptDirectory,
                     java.lang.String scriptAuthor,
                     java.lang.String scriptVersion)
              throws RClientException,
                     RSecurityException,
                     RDataException

Submit a single repository-managed script or a chain of repository-managed scripts to execute as a job.

To submit a chain of repository-managed scripts on this call provide a comma-separated list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

Returns:

RJob

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

submitJobScript

RJob submitJobScript(java.lang.String jobName,
                     java.lang.String jobDescr,
                     java.lang.String scriptName,
                     java.lang.String scriptDirectory,
                     java.lang.String scriptAuthor,
                     java.lang.String scriptVersion,
                     JobExecutionOptions options)
              throws RClientException,
                     RSecurityException,
                     RDataException

Submit a single repository-managed script or a chain of repository-managed scripts to execute as a job.

To submit a chain of repository-managed scripts on this call provide a comma-separated list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

Returns:

RJob

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

submitJobExternal

RJob submitJobExternal(java.lang.String jobName,
                       java.lang.String jobDescr,
                       java.lang.String externalSource,
                       JobExecutionOptions options)
                throws RClientException,
                       RSecurityException,
                       RDataException

Submit a single script found on a URL/path or a chain of scripts found on a set of URLs/paths on the current project.

To submit a chain of repository-managed scripts on this call provide a comma-separated list of values on the externalSource parameter.

POWER_USER privileges are required for this call.

Returns:

RJob

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException