Module com.powsybl.computation.slurm

Package com.powsybl.computation.slurm

Interface SlurmTask

All Known Implementing Classes:

AbstractTask, SlurmTaskImpl

public interface SlurmTask

Represents a user submitted tasks, which will probably required the execution of multiple underlying individual jobs on the slurm infrastructure.

Author:

Sylvain Leclerc <sylvain.leclerc at rte-france.com>

Method Summary

Modifier and Type	Method	Description
com.powsybl.computation.ExecutionReport	await()	Waits for the whole task to be executed, and generates the execution report.
List<MonitoredJob>	getPendingJobs()	Provides the list of jobs for which completion status needs to be monitored.
void	interrupt()	Asks for interruption of the execution of this task, in order to save the infrastructure computation resources.
void	submit()	Submits all jobs required to complete this task to the Slurm infrastructure.

Method Details

submit

void submit()
     throws IOException

Submits all jobs required to complete this task to the Slurm infrastructure.

Throws:

IOException

await

com.powsybl.computation.ExecutionReport await()
                                       throws InterruptedException,
ExecutionException

Waits for the whole task to be executed, and generates the execution report.

Throws:

CancellationException - if the task has been interrupted by a call to interrupt().

InterruptedException

ExecutionException

interrupt

void interrupt()

Asks for interruption of the execution of this task, in order to save the infrastructure computation resources.

Calls waiting for completion of await() will throw a CancellationException.

getPendingJobs

List<MonitoredJob> getPendingJobs()

Provides the list of jobs for which completion status needs to be monitored.