Index (Slurm computation manager 3.0.0 API)

A C D E F G H I J L M N P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractSlurmCmdResult - Class in com.powsybl.computation.slurm
AbstractSlurmJobMonitor - Class in com.powsybl.computation.slurm: Abstract base class for jobs monitors, in charge of monitoring the status of submitted jobs.
AbstractSlurmJobMonitor(Supplier<List<MonitoredJob>>) - Constructor for class com.powsybl.computation.slurm.AbstractSlurmJobMonitor
AbstractTask - Class in com.powsybl.computation.slurm
AbstractTask.CompletableMonitoredJob - Class in com.powsybl.computation.slurm
await() - Method in class com.powsybl.computation.slurm.AbstractTask
await() - Method in interface com.powsybl.computation.slurm.SlurmTask: Waits for the whole task to be executed, and generates the execution report.

C

cancelSubmittedJobs() - Method in class com.powsybl.computation.slurm.AbstractTask: Asks for cancellation of submitted jobs to Slurm infrastructure.
cannotSubmit() - Method in class com.powsybl.computation.slurm.AbstractTask: Check if task has already been completed, or if computation manager is closing.
close() - Method in interface com.powsybl.computation.slurm.CommandExecutor
close() - Method in class com.powsybl.computation.slurm.SlurmComputationManager
com.powsybl.computation.slurm - module com.powsybl.computation.slurm
com.powsybl.computation.slurm - package com.powsybl.computation.slurm
commandByJobId - Variable in class com.powsybl.computation.slurm.AbstractTask
commandExecutor - Variable in class com.powsybl.computation.slurm.AbstractTask
CommandExecutor - Interface in com.powsybl.computation.slurm: Simple interface to execute shell commands, 1 at a time.
commandResult - Variable in class com.powsybl.computation.slurm.AbstractSlurmCmdResult
CommandResult - Record Class in com.powsybl.computation.slurm: The results of the execution of a shell command: the exit code, and standard output and standard error as strings.
CommandResult(int, String, String) - Constructor for record class com.powsybl.computation.slurm.CommandResult: Creates an instance of a CommandResult record class.
copyShellToRemoteWorkingDir(List<String>, String) - Method in class com.powsybl.computation.slurm.AbstractTask
create() - Method in class com.powsybl.computation.slurm.SlurmComputationManagerFactory

D

detectJobsState(List<MonitoredJob>) - Method in class com.powsybl.computation.slurm.AbstractSlurmJobMonitor
detectJobsState(List<MonitoredJob>) - Method in class com.powsybl.computation.slurm.ScontrolMonitor
done() - Method in class com.powsybl.computation.slurm.AbstractTask.CompletableMonitoredJob: To be called by a monitor when the job has ended successfully.
done() - Method in interface com.powsybl.computation.slurm.MonitoredJob: To be called by a monitor when the job has completed successfully.

E

environment - Variable in class com.powsybl.computation.slurm.AbstractTask
equals(Object) - Method in record class com.powsybl.computation.slurm.CommandResult: Indicates whether some other object is "equal to" this one.
execute(ExecutionEnvironment, ExecutionHandler<R>) - Method in class com.powsybl.computation.slurm.SlurmComputationManager
execute(ExecutionEnvironment, ExecutionHandler<R>, ComputationParameters) - Method in class com.powsybl.computation.slurm.SlurmComputationManager
execute(String) - Method in interface com.powsybl.computation.slurm.CommandExecutor
executions - Variable in class com.powsybl.computation.slurm.AbstractTask
exitCode() - Method in record class com.powsybl.computation.slurm.CommandResult: Returns the value of the exitCode record component.

F

failed() - Method in class com.powsybl.computation.slurm.AbstractTask.CompletableMonitoredJob: To be called by a monitor when the job has failed.
failed() - Method in interface com.powsybl.computation.slurm.MonitoredJob: To be called by a monitor when the job has completed but with an error (exit code !
flagDir - Variable in class com.powsybl.computation.slurm.AbstractTask

G

getCause() - Method in exception com.powsybl.computation.slurm.UncheckedJSchException
getExecutor() - Method in class com.powsybl.computation.slurm.SlurmComputationManager
getJobId() - Method in class com.powsybl.computation.slurm.AbstractTask.CompletableMonitoredJob: This job ID in slurm
getJobId() - Method in interface com.powsybl.computation.slurm.MonitoredJob: This job ID in slurm
getLocalDir() - Method in class com.powsybl.computation.slurm.SlurmComputationManager
getMem() - Method in class com.powsybl.computation.slurm.SlurmComputationParameters
getName() - Method in class com.powsybl.computation.slurm.SlurmComputationParameters
getPendingJobs() - Method in class com.powsybl.computation.slurm.AbstractTask: The list of jobs for which status must be monitored.
getPendingJobs() - Method in interface com.powsybl.computation.slurm.SlurmTask: Provides the list of jobs for which completion status needs to be monitored.
getQos() - Method in class com.powsybl.computation.slurm.SlurmComputationParameters
getResourcesStatus() - Method in class com.powsybl.computation.slurm.SlurmComputationManager
getVersion() - Method in class com.powsybl.computation.slurm.SlurmComputationManager

H

hashCode() - Method in record class com.powsybl.computation.slurm.CommandResult: Returns a hash code value for this object.

I

interrupt() - Method in class com.powsybl.computation.slurm.AbstractTask
interrupt() - Method in interface com.powsybl.computation.slurm.SlurmTask: Asks for interruption of the execution of this task, in order to save the infrastructure computation resources.
interrupted() - Method in class com.powsybl.computation.slurm.AbstractTask.CompletableMonitoredJob: To be called if the job is detected to have been killed before completing.
interrupted() - Method in interface com.powsybl.computation.slurm.MonitoredJob: To be called by a monitor if the job is detected to have been killed before completing.
isOk() - Method in class com.powsybl.computation.slurm.AbstractSlurmCmdResult
isOk() - Method in interface com.powsybl.computation.slurm.SlurmCmdResult

J

jobs - Variable in class com.powsybl.computation.slurm.AbstractTask

L

launchSbatch(SbatchCmd) - Method in class com.powsybl.computation.slurm.AbstractTask
load() - Static method in class com.powsybl.computation.slurm.SlurmComputationConfig
load(PlatformConfig) - Static method in class com.powsybl.computation.slurm.SlurmComputationConfig

M

MonitoredJob - Interface in com.powsybl.computation.slurm: An individual job submitted to slurm, an which completion or failure needs to be monitored.

N

newCommonFile(String) - Method in class com.powsybl.computation.slurm.SlurmComputationManager

P

parameters - Variable in class com.powsybl.computation.slurm.AbstractTask

R

run() - Method in class com.powsybl.computation.slurm.AbstractSlurmJobMonitor

S

SbatchCmd - Class in com.powsybl.computation.slurm: A submission command to Slurm: sbatch options scriptName.
ScontrolCmdFactory - Class in com.powsybl.computation.slurm
ScontrolMonitor - Class in com.powsybl.computation.slurm: A job monitor which uses "scontrol show job ID_OF_JOB" to get state of job, in case, the job itself can not finish completely.
setCounter(int) - Method in class com.powsybl.computation.slurm.AbstractTask.CompletableMonitoredJob
SlurmCmdNonZeroException - Exception in com.powsybl.computation.slurm
SlurmCmdResult - Interface in com.powsybl.computation.slurm
SlurmComputationConfig - Class in com.powsybl.computation.slurm
SlurmComputationConfig.SshConfig - Class in com.powsybl.computation.slurm
SlurmComputationManager - Class in com.powsybl.computation.slurm
SlurmComputationManager(SlurmComputationConfig) - Constructor for class com.powsybl.computation.slurm.SlurmComputationManager
SlurmComputationManagerFactory - Class in com.powsybl.computation.slurm
SlurmComputationManagerFactory() - Constructor for class com.powsybl.computation.slurm.SlurmComputationManagerFactory
SlurmComputationParameters - Class in com.powsybl.computation.slurm
SlurmComputationParameters(ComputationParameters, String) - Constructor for class com.powsybl.computation.slurm.SlurmComputationParameters
SlurmComputationParameters(ComputationParameters, String, Integer) - Constructor for class com.powsybl.computation.slurm.SlurmComputationParameters: Additionnal parameters for slurm
SlurmException - Exception in com.powsybl.computation.slurm
SlurmException(String) - Constructor for exception com.powsybl.computation.slurm.SlurmException
SlurmException(Throwable) - Constructor for exception com.powsybl.computation.slurm.SlurmException
SlurmTask - Interface in com.powsybl.computation.slurm: Represents a user submitted tasks, which will probably required the execution of multiple underlying individual jobs on the slurm infrastructure.
SlurmTaskImpl - Class in com.powsybl.computation.slurm: A SlurmTask which submits each command as an individual slurm job.
SshConfig(String, int, String, String, int, int) - Constructor for class com.powsybl.computation.slurm.SlurmComputationConfig.SshConfig
stdErr() - Method in record class com.powsybl.computation.slurm.CommandResult: Returns the value of the stdErr record component.
stdOut() - Method in record class com.powsybl.computation.slurm.CommandResult: Returns the value of the stdOut record component.
submit() - Method in interface com.powsybl.computation.slurm.SlurmTask: Submits all jobs required to complete this task to the Slurm infrastructure.
submit() - Method in class com.powsybl.computation.slurm.SlurmTaskImpl

T

taskCompletion - Variable in class com.powsybl.computation.slurm.AbstractTask
toString() - Method in record class com.powsybl.computation.slurm.CommandResult: Returns a string representation of this record class.
toString() - Method in class com.powsybl.computation.slurm.SbatchCmd

U

UncheckedJSchException - Exception in com.powsybl.computation.slurm
UncheckedJSchException(JSchException) - Constructor for exception com.powsybl.computation.slurm.UncheckedJSchException
UNZIP_INPUTS_COMMAND_ID - Static variable in class com.powsybl.computation.slurm.AbstractTask

W

workingDir - Variable in class com.powsybl.computation.slurm.AbstractTask

A C D E F G H I J L M N P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form