com.tupilabs.pbs

Class PBS

java.lang.Object

com.tupilabs.pbs.PBS

public class PBS
extends Object

PBS Java API.

Since:

0.1

Author:

Bruno P. Kinoshita

Constructor Summary

Constructors

Constructor and Description
PBS()

Method Summary

Modifier and Type	Method and Description
static void	qdel(String jobId) PBS qdel command.
static List<Node>	qnodes() PBS qnodes command.
static List<Node>	qnodes(String name) PBS qnodes command.
static List<Job>	qstat() PBS qstat command.
static List<Job>	qstat(Job job) PBS qstat command.
static List<Job>	qstat(Queue queue) PBS qstat command.
static List<Job>	qstat(String name) PBS qstat command.
static List<Job>	qstatArrayJob(String name) PBS qstat command for Array Jobs
static List<Queue>	qstatQueues() PBS qstat command.
static List<Queue>	qstatQueues(String name) PBS qstat command.
static String	qsub(String input) PBS qsub command.
static String	qsub(String[] inputs, Map<String,String> environment) PBS qsub command.
static String	qsub(String input, String... resourceOverrides) PBS qsub command with arguments resource overrides
static String	qsubArrayJob(String input, int beginIndex, int endIndex) PBS qsub command for an Array Job with Specific PBS_ARRAY_IDs to submit
static String	qsubArrayJob(String input, List<Integer> pbsArrayIDs) PBS qsub command for an Array Job with Specific PBS_ARRAY_IDs to submit
static String	qsubArrayJob(String input, List<Integer> pbsArrayIDs, int beginIndex, int endIndex) PBS qsub command for an Array Job with Specific PBS_ARRAY_IDs to submit AND a range to submit
static String	qsubArrayJob(String input, List<Integer> pbsArrayIDs, String... resourceOverrides) PBS qsub command for an Array Job with Specific PBS_ARRAY_IDs to submit, and resource overrides
static CommandOutput	traceJob(String jobId, int numberOfDays) PBS tracejob command.
static CommandOutput	traceJob(String jobId, int numberOfDays, boolean quiet) PBS tracejob command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PBS

public PBS()

Method Detail

qnodes

public static List<Node> qnodes()

PBS qnodes command.

Get information about the cluster nodes.

Returns:

list of nodes

Throws:

PBSException - if an error communicating with the PBS occurs

qnodes

public static List<Node> qnodes(String name)

PBS qnodes command.

Get information about the cluster nodes.

Parameters:

name - node name

Returns:

list of nodes

Throws:

PBSException - if an error communicating with the PBS occurs

qstatQueues

public static List<Queue> qstatQueues()

PBS qstat command.

Equivalent to qstat -Q -f [name]

Returns:

list of queues

qstatQueues

public static List<Queue> qstatQueues(String name)

PBS qstat command.

Equivalent to qstat -Q -f [name]

Parameters:

name - queue name

Returns:

list of queues

qstat

public static List<Job> qstat()

PBS qstat command.

Equivalent to qstat -f

Returns:

list of jobs

qstat

public static List<Job> qstat(Queue queue)

PBS qstat command.

Equivalent to qstat -f [queue_name]

Parameters:

queue - PBS Queue

Returns:

list of jobs

qstat

public static List<Job> qstat(Job job)

PBS qstat command.

Equivalent to qstat -f [job_name]

Parameters:

job - the PBS Job

Returns:

list of jobs

qstat

public static List<Job> qstat(String name)

PBS qstat command.

Equivalent to qstat -f [param]

Parameters:

name - job name

Returns:

list of jobs

qstatArrayJob

public static List<Job> qstatArrayJob(String name)

PBS qstat command for Array Jobs

Equivalent to qstat -f -t [param]

Parameters:

name - job name

Returns:

list of jobs

qdel

public static void qdel(String jobId)

PBS qdel command.

Equivalent to qdel [param]

Parameters:

jobId - job id

qsub

public static String qsub(String input)

PBS qsub command.

Equivalent to qsub [param]

Parameters:

input - job input file

Returns:

job id

qsub

public static String qsub(String input,
                          String... resourceOverrides)

PBS qsub command with arguments resource overrides

Equivalent to qsub [param] -l [resource_name=value,resource_name=value]]

Parameters:

input - job input file

resourceOverrides - variable number of resources to override

Returns:

job id

qsubArrayJob

public static String qsubArrayJob(String input,
                                  List<Integer> pbsArrayIDs)

PBS qsub command for an Array Job with Specific PBS_ARRAY_IDs to submit

Equivalent to qsub -t 1,2,3 [param]

Parameters:

input - job input file

pbsArrayIDs - list of specified PBS indices

Returns:

job id of array job

qsub

public static String qsub(String[] inputs,
                          Map<String,String> environment)

PBS qsub command.

Equivalent to qsub [param]

Parameters:

inputs - job input file

environment - environment variables

Returns:

job id

qsubArrayJob

public static String qsubArrayJob(String input,
                                  List<Integer> pbsArrayIDs,
                                  String... resourceOverrides)

PBS qsub command for an Array Job with Specific PBS_ARRAY_IDs to submit, and resource overrides

Equivalent to qsub -t 1,2,3 -l [resource_name=value,resource_name=value] [param]

Parameters:

input - job input file

pbsArrayIDs - of specified PBS indices

resourceOverrides - list of resource overrides

Returns:

job id of array job

qsubArrayJob

public static String qsubArrayJob(String input,
                                  int beginIndex,
                                  int endIndex)

PBS qsub command for an Array Job with Specific PBS_ARRAY_IDs to submit

Equivalent to qsub -t 5-20 [param]

Parameters:

input - job input file

beginIndex - beginning of index range

endIndex - end of index range

Returns:

job id of array job

qsubArrayJob

public static String qsubArrayJob(String input,
                                  List<Integer> pbsArrayIDs,
                                  int beginIndex,
                                  int endIndex)

PBS qsub command for an Array Job with Specific PBS_ARRAY_IDs to submit AND a range to submit

Equivalent to qsub -t 1,2,3,5-20 [param]

Parameters:

input - job input file

pbsArrayIDs - list of specified indices

beginIndex - beginning of index range

endIndex - end of index range

Returns:

job id of array job

traceJob

public static CommandOutput traceJob(String jobId,
                                     int numberOfDays)

PBS tracejob command.

Equivalent to tracejob -n [numberOfDays] [jobId]

Parameters:

jobId - job id

numberOfDays - number of days to look for the job

Returns:

tracejob output

traceJob

public static CommandOutput traceJob(String jobId,
                                     int numberOfDays,
                                     boolean quiet)

PBS tracejob command.

Equivalent to tracejob -n [numberOfDays] [jobId]

Parameters:

jobId - job id

numberOfDays - number of days to look for the job

quiet - quiet mode flag

Returns:

tracejob output