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)
Gets the
JobSubmission that contains job information and the job execution status for the job that
created SAS session. |
List<JobSubmission> |
getJobSubmissionsByJobPath(String path)
Gets job submission entries for the repository job 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)
Gets the latest job submission entry for the repository job by the job path.
|
Manifest |
getManifestByJobSubmission(String jobSubmissionId)
Gets the job manifest file for the job submission.
|
Manifest |
getManifestByRepositoryPath(String path,
String version)
Gets the job manifest file at the path and version.
|
JobSubmission |
submitAndPopulateWorkspaceJob(String path,
Set<ParameterValue> parameterValues,
boolean useRelativePaths)
Submits the 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 the job in the repository.
|
JobSubmission |
submitWorkspaceJob(String path,
Set<ParameterValue> parameterValues)
Submits the job in the current user's workspace.
|
JobSubmission submitWorkspaceJob(String path, Set<ParameterValue> parameterValues)
path
- The path of job.parameterValues
- The override of the default value of the JobParameters that are defined in the job. For
parameters of type FILE and FOLDER, the value should an
ItemSpecification
. Values of CHARACTER and NUMERIC parameters
should be Strings. Values of DATE parameter type should be java.util.Date. If no parameters are
specified, the default values defined in the job are used.JobSubmission submitRepositoryJob(String path, String version, Set<ParameterValue> parameterValues)
path
- The path of job.version
- The version of the repository job to run. Specifying null runs the latest version of the job.parameterValues
- The override of the default value of the JobParameters that are defined in the job. For
parameters of type FILE and FOLDER, the value should be an
ItemSpecification
. Values of CHARACTER and NUMERIC parameters
should be Strings. Date parameter values should be java.util.Date. If no parameters are specified, the
default values in the job are used.JobSubmission getJobSubmission(String id) throws JobSubmissionNotFoundException
id
- The JobSubmission identifier for a specific job submission.JobSubmissionNotFoundException
- Thrown when the job submission with the identifier does not exist.JobSubmissionStatus getJobSubmissionStatus(String jobSubmissionId) throws JobSubmissionNotFoundException
JobSubmissionStatus
for status details.jobSubmissionId
- The identifier of the job submission that is returned from submitting the job.JobSubmissionNotFoundException
- Thrown when the job submission with the identifier does not exist.JobSubmission submitAndPopulateWorkspaceJob(String path, Set<ParameterValue> parameterValues, boolean useRelativePaths)
path
- The path of workspace job.parameterValues
- The override of the default value of the JobParameters that are defined in the job. For
parameters of type FILE and FOLDER, the value should be an
ItemSpecification
. Values of CHARACTER and NUMERIC parameters
should be Strings. Date parameter values should be java.util.Date. If no parameters are specified, the
default values in the job are used.useRelativePaths
- Indicates whether to use relative paths when updating the inputs and outputs of the job.JobSubmission getJobSubmissionBySasSession(String sessionId) throws JobSubmissionNotFoundException
JobSubmission
that contains job information and the job execution status for the job that
created SAS session. If the SAS session is not created by a job, null is returned.sessionId
- The identifier that represents the SAS session.JobSubmissionNotFoundException
- Thrown when the job submission does not exist for the SAS session.Manifest getManifestByRepositoryPath(String path, String version) throws ResultsNotFoundException
path
- The path to the job manifest file.version
- The version of the manifest file. If null, the latest version is returned.ResultsNotFoundException
- Thrown when the job manifest file or the version does not exist at the path.Manifest getManifestByJobSubmission(String jobSubmissionId) throws ResultsNotFoundException
jobSubmissionId
- The identifier of the job submission for which to get the job manifest.ResultsNotFoundException
- Thrown when the job manifest file does not exist for the job submission.List<JobSubmission> getJobSubmissionsByJobPath(String path)
path
- The path of the job.JobSubmission getLatestJobSubmissionByJobPath(String path)
path
- The path of the job.Copyright (c) 2019, SAS Institute Inc., Cary, NC, USA