\(\renewcommand\AA{\unicode{x212B}}\)

AbortRemoteJob v2

../_images/AbortRemoteJob-v2_dlg.png

AbortRemoteJob dialog.

Warning

AbortRemoteJob is deprecated and has no replacement.

Summary

Abort a previously submitted job.

Properties

Name Direction Type Default Description
ComputeResource Input string Mandatory The remote computer where the job is running
JobID Input string Mandatory The ID of the job to abort

Description

Abort (cancel/kill/stop) a job that has been previously submitted to a remote compute resource. The job must have been submitted using SubmitRemoteJob v2. And jobs are always submitted within a transaction. The transaction must have been created previously with StartRemoteTransaction v2.

For more details on remote algorithms when using the Mantid web service remote job submission API, see the remote job submission API docs.

Previous Versions

Version 1

Version 1 aborts jobs using the Mantid remote job submission API. This is still supported as one of the variants of Versions 2 and above, when the compute resource uses the Mantid remote job submission API as job manager (underlying remote job scheduling mechanism).

Categories: AlgorithmIndex | Remote | Deprecated

Source

C++ header: AbortRemoteJob2.h (last modified: 2021-06-03)

C++ source: AbortRemoteJob2.cpp (last modified: 2021-03-31)