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 |
getJobSubmissionBySession(String sessionId)
Gets the
JobSubmission , which contains job information and the job execution status for the job that
created the 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 in the repository.
|
Manifest |
getManifestByWorkspacePath(String path)
Gets the job manifest file at the path in the workspace.
|
JobSubmission |
submitAndPopulateWorkspaceJob(String path,
List<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 that are accessed during the job run.
|
JobSubmission |
submitRepositoryJob(String path,
String version,
List<ParameterValue> parameterValues)
Submits the job in the repository.
|
JobSubmission |
submitTestJob(String path,
List<ParameterValue> parameterValues)
Submits the job as it would for a published job, which accesses items in the repository, but outputs are not
checked in.
|
JobSubmission |
submitWorkspaceJob(String path,
List<ParameterValue> parameterValues)
Submits the job in the current user's workspace.
|
JobSubmission submitWorkspaceJob(String path, List<ParameterValue> parameterValues)
path
- The path to the job.parameterValues
- The values that override the default values of the JobParameters that are defined in the
job. For parameters of type FILE and FOLDER, the value must be a
JobInput
. The values of CHARACTER and NUMERIC parameters must be
Strings. The values of DATE parameter type must be java.util.Date. If no parameters are specified, the
default values that are defined in the job are used.JobSubmission submitTestJob(String path, List<ParameterValue> parameterValues)
path
- The path to the job.parameterValues
- The values that override the default values of the JobParameters that are defined in the
job. For parameters of type FILE and FOLDER, the value must be a
JobInput
. The values of CHARACTER and NUMERIC parameters must be
Strings. The values of DATE parameter type must be java.util.Date. If no parameters are specified, the
default values defined in the job are used.JobSubmission submitRepositoryJob(String path, String version, List<ParameterValue> parameterValues)
path
- The path to the job.version
- The version of the repository job to run. Specifying null uses the latest version of the job.parameterValues
- The override values of the default values of the JobParameters that are defined in the
job. For parameters of type FILE and FOLDER, the value must be a
JobInput
. The values of CHARACTER and NUMERIC parameters must be
Strings. The date parameter values must 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, List<ParameterValue> parameterValues, boolean useRelativePaths)
path
- The path of workspace job.parameterValues
- The override values of the default values of the JobParameters that are defined in the
job. For parameters of type FILE and FOLDER, the value must be a
JobInput
. The values of CHARACTER and NUMERIC parameters must be
Strings. The date parameter values must be java.util.Date. If no parameters are specified, the default
values in the job are used.useRelativePaths
- Indicates whether to use relative paths to update the inputs and outputs of the job.JobSubmission getJobSubmissionBySession(String sessionId) throws JobSubmissionNotFoundException
JobSubmission
, which contains job information and the job execution status for the job that
created the session.sessionId
- The identifier that represents the session.JobSubmissionNotFoundException
- Thrown when a job submission does not exist for the 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 getManifestByWorkspacePath(String path) throws ResultsNotFoundException
path
- The path to the job manifest file.ResultsNotFoundException
- Thrown when the job manifest file does not exist.Manifest getManifestByJobSubmission(String jobSubmissionId) throws ResultsNotFoundException
jobSubmissionId
- The identifier of the job submission.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.JobSubmissionNotFoundException
- Thrown when a job submission is not found for the repository job
path.<i>Copyright (c) 2020, SAS Institute Inc., Cary, NC, USA</i>