public interface JobSubmissionService
Modifier and Type | Method and Description |
---|---|
JobSubmission |
getJobSubmission(String id)
Gets the current job submission for a specific submission of a job.
|
JobSubmission |
getJobSubmissionBySasSession(String sessionId)
Get the
JobSubmission containing job information and job execution status for job that created the
specified SAS session. |
List<JobSubmission> |
getJobSubmissionsByJobPath(String path)
Get job submission entries for the repository job specified by the job path
|
JobSubmissionStatus |
getJobSubmissionStatus(String jobSubmissionId)
Gets the current job submission status for a specific submission of a job.
|
JobSubmission |
getLatestJobSubmissionByJobPath(String path)
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 |
submitAndPopulateWorkspaceJob(String path,
Set<ParameterValue> parameterValues,
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 |
submitRepositoryJob(String path,
String version,
Set<ParameterValue> parameterValues)
Submits job in the repository.
|
JobSubmission |
submitWorkspaceJob(String path,
Set<ParameterValue> parameterValues)
Submits job in the current user's workspace.
|
JobSubmission submitWorkspaceJob(String path, Set<ParameterValue> parameterValues)
path
- Path of job to submitparameterValues
- 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 an
ItemSpecification
. 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.JobSubmission submitRepositoryJob(String path, String version, Set<ParameterValue> parameterValues)
path
- Path of job to submitversion
- Version of repository job to run. Specifying null will run the latest version of the job.parameterValues
- 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 an
ItemSpecification
. 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.JobSubmission getJobSubmission(String id) throws JobSubmissionNotFoundException
id
- JobSubmission id for a specific job submissionJobSubmissionNotFoundException
- thrown if the job submission does not exist with the specified idJobSubmissionStatus getJobSubmissionStatus(String jobSubmissionId) throws JobSubmissionNotFoundException
JobSubmissionStatus
for status details.jobSubmissionId
- id of the job submission returned from submitting a job.JobSubmissionNotFoundException
- thrown if the job submission does not exist with the specified idJobSubmission submitAndPopulateWorkspaceJob(String path, Set<ParameterValue> parameterValues, boolean useRelativePaths)
path
- Path of job to submit in the workspaceparameterValues
- 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 an
ItemSpecification
. 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 jobJobSubmission getJobSubmissionBySasSession(String sessionId) throws JobSubmissionNotFoundException
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.sessionId
- the identifier representing the SAS sessionJobSubmissionNotFoundException
- thrown if the job submission does not exist for the specified SAS sessionManifest getManifestByRepositoryPath(String path, String version) throws ResultsNotFoundException
path
- the path to the job manifest fileversion
- the version of the manifest file to get. if null, the latest version will be returned.ResultsNotFoundException
- thrown if the job manifest or version does not exist at the path specifiedManifest getManifestByJobSubmission(String jobSubmissionId) throws ResultsNotFoundException
jobSubmissionId
- the identifier of the job submission in which to get the job manifestResultsNotFoundException
- thrown if the job manifest does not exist for the job submissionList<JobSubmission> getJobSubmissionsByJobPath(String path)
path
- path of the job in the repositoryJobSubmission getLatestJobSubmissionByJobPath(String path)
path
- path of the job in the repositoryCopyright (c) 2019, SAS Institute Inc., Cary, NC, USA