public interface JobExecutionService
Modifier and Type | Method and Description |
---|---|
JobSubmission |
getJobSubmissionForSasSession(String identifier)
Get the
JobSubmission containing job information and job execution status for job that created the specified SAS session. |
List<JobSubmission> |
getJobSubmissionsByJobPath(String jobPath)
Get job submission entries for the repository job specified by the job path
|
JobStatus |
getJobSubmissionStatus(JobSubmission jobSubmission)
Gets the current job submission status for a specific submission of a job.
|
JobSubmission |
getLatestJobSubmissionByJobPath(String jobPath)
Get the latest job submission entry for the repository job specified by the job path
|
Manifest |
getManifestByJobSubmission(String jobSubmissionId)
Get the job manifest for the specified job submission
|
Manifest |
getManifestByRepositoryPath(String path,
String version)
Get the job manifest at the path and version specified.
|
JobSubmission |
submitJobInRepository(String jobPath,
String version,
Set<ParameterValue> params)
Submits job in the repository.
|
JobSubmission |
submitJobInWorkspace(String jobPath,
Set<ParameterValue> params)
Submits job in the current user's workspace.
|
JobSubmission |
submitJobInWorkspaceAndPopulate(String jobPath,
Set<ParameterValue> params,
boolean useRelativePaths)
Submits job in the workspace and updates the input and output specifications in the job based on inputs and
outputs accessed during the job run.
|
JobSubmission submitJobInWorkspace(String jobPath, Set<ParameterValue> params) throws JobExecutionException, JobNotFoundException
jobPath
- Path of job to submitparams
- ParameterValues will override the default value of the JobParameters defined within the job. For
parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values
of CHARACTER and NUMERIC parameters should be specified as Strings. Values of DATE parameter type
should be specified as java.util.Date. If no parameters are specified, the default values defined in
the job will be used.JobExecutionException
- Thrown if an issue occurred executing the jobJobNotFoundException
- Thrown if the job does not exist at the path specified in the workspaceJobSubmission submitJobInRepository(String jobPath, String version, Set<ParameterValue> params) throws JobExecutionException, JobNotFoundException, JobVersionNotFoundException
jobPath
- Path of job to submitversion
- Version of repository job to run. Specifying null will run the latest version of the job.params
- ParameterValues will override the default value of the JobParameters defined within the job. For
parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values
of CHARACTER and NUMERIC parameters should be specified as Strings. Date parameter values should be
specified as java.util.Date. If no parameters are specified, the default values in the job will be
used.JobExecutionException
- Thrown if an issue occurred executing the jobJobNotFoundException
- Thrown if the job does not exist at the path specified in the repositoryJobVersionNotFoundException
- Thrown if the version of the job does not exist in the repositoryJobStatus getJobSubmissionStatus(JobSubmission jobSubmission)
JobStatus
for status details.jobSubmission
- JobSubmission returned from submitting a job.JobSubmission submitJobInWorkspaceAndPopulate(String jobPath, Set<ParameterValue> params, boolean useRelativePaths) throws JobExecutionException, JobNotFoundException
jobPath
- Path of job to submit in the workspaceparams
- ParameterValues will override the default value of the JobParameters defined within the job. For
parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values
of CHARACTER and NUMERIC parameters should be specified as Strings. Date parameter values should be
specified as java.util.Date. If no parameters are specified, the default values in the job will be
used.useRelativePaths
- specifies whether to use relative paths when updating the inputs and outputs for the jobJobExecutionException
- Thrown if an issue occurred executing the jobJobNotFoundException
- Thrown if the job does not exist at the path specified in the workspaceJobSubmission getJobSubmissionForSasSession(String identifier) throws SessionNotFoundException
JobSubmission
containing job information and job execution status for job that created the specified SAS session.
If the SAS session specified was not created by a job, null will be returned.identifier
- the identifier representing the SAS sessionSessionNotFoundException
- thrown if the SAS session does not existManifest getManifestByRepositoryPath(String path, String version) throws ResourceNotFoundException
path
- the path to the job manifest fileversion
- the version of the manifest file to get. if null, the latest version will be returned.ResourceNotFoundException
- thrown if the job manifest or version does not exist at the path specified in the repositoryManifest getManifestByJobSubmission(String jobSubmissionId) throws ResourceNotFoundException
jobSubmissionId
- the identifier of the job submission in which to get the job manifestResourceNotFoundException
- thrown if the job manifest does not exist for the job submissionList<JobSubmission> getJobSubmissionsByJobPath(String jobPath) throws JobNotFoundException
jobPath
- path of the job in the repositoryJobNotFoundException
- thrown if the job does not exist at the path specified in the repositoryJobSubmission getLatestJobSubmissionByJobPath(String jobPath) throws JobNotFoundException
jobPath
- path of the job in the repositoryJobNotFoundException
- thrown if the job does not exist at the path specified in the repositoryCopyright (c) 2017, SAS Institute Inc., Cary, NC, USA