sfapi-ts

Home > @cjh1/sfapi > ComputeService > getJobs

ComputeService.getJobs() method

Read Jobs Get information about jobs running on NERSC compute resources.

• **machine**: the NERSC compute resource - **index**: the index of the first job info to retrieve - **limit**: (optional) how many job infos to retrieve - **sacct**: (optional) if true, use sacct otherwise squeue to get the job info - **kwargs**: (optional) a list of key/value pairs (in the form of name=value) to filter job results by

Signature:

getJobs(machine: PublicHost, index?: number, limit?: number, sacct?: boolean, kwargs?: Array<string>): CancelablePromise<QueueOutput>;

Parameters

Parameter	Type	Description
machine	PublicHost
index	number	(Optional)
limit	number	(Optional)
sacct	boolean	(Optional)
kwargs	Array<string>	(Optional)

Returns:

CancelablePromise<QueueOutput>

QueueOutput Successful Response

Exceptions

ApiError