Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.jobtemplates
[Groovy] Class JobTemplate

java.lang.Object
  com.ace.mws.jobtemplates.JobTemplate

class JobTemplate

This class represents a job template in the Moab Workload Manager. Job templates are used for two primary purposes: (1) to provide a means of generically matching and categorizing jobs, and (2) to provide a means of setting arbitrary default or forced attributes for certain jobs.

Field Summary
private String account

The account under which this job will run for billing purposes.
private String args

Command-line arguments that get passed to commandFile.
private String commandFile

The path to the file that is executed when the job runs.

private String description

The description of the job.
private Long durationRequested

The amount of time (in seconds) requested for the job.
private Boolean genericSystemJob

True if this template will instantiate a generic system job.
private String id

The unique identifier for this job template.
private Boolean inheritResources

True if jobs instantiated from this template inherit resources.
private Set jobDependencies

(JobTemplateDependency collection) The list of dependencies for this job template.
private Set jobFlags

(JobFlag collection) Job flags for this template.
private Set jobTemplateFlags

(JobTemplateFlag collection) Job template flags for this template.
private Set jobTemplateRequirements

(JobTemplateRequirement collection) The requirements for this job template.
private Long priority

Relative job priority.
private String qos

The Quality of Service for the job.
private String queue

The class or queue in which the job will run.
private Boolean select

True if job template can be directly requested by job at submission.
private Trigger trigger

The trigger that is typically assigned to generic system jobs.
private VMUsagePolicy vmUsagePolicy

The virtual machine usage policy.
 
Constructor Summary
JobTemplate()

 
Method Summary
String getAccount()

The account under which this job will run for billing purposes.
String getArgs()

Command-line arguments that get passed to commandFile.
String getCommandFile()

The path to the file that is executed when the job runs.

String getDescription()

The description of the job.
Long getDurationRequested()

The amount of time (in seconds) requested for the job.
Boolean getGenericSystemJob()

True if this template will instantiate a generic system job.
String getId()

The unique identifier for this job template.
Boolean getInheritResources()

True if jobs instantiated from this template inherit resources.
Set getJobDependencies()

(JobTemplateDependency collection) The list of dependencies for this job template.
Set getJobFlags()

(JobFlag collection) Job flags for this template.
Set getJobTemplateFlags()

(JobTemplateFlag collection) Job template flags for this template.
Set getJobTemplateRequirements()

(JobTemplateRequirement collection) The requirements for this job template.
Long getPriority()

Relative job priority.
String getQos()

The Quality of Service for the job.
String getQueue()

The class or queue in which the job will run.
Boolean getSelect()

True if job template can be directly requested by job at submission.
Trigger getTrigger()

The trigger that is typically assigned to generic system jobs.
VMUsagePolicy getVmUsagePolicy()

The virtual machine usage policy.
void setAccount(String account)

The account under which this job will run for billing purposes.
void setArgs(String args)

Command-line arguments that get passed to commandFile.
void setCommandFile(String commandFile)

The path to the file that is executed when the job runs.

void setDescription(String description)

The description of the job.
void setDurationRequested(Long durationRequested)

The amount of time (in seconds) requested for the job.
void setGenericSystemJob(Boolean genericSystemJob)

True if this template will instantiate a generic system job.
void setId(String id)

The unique identifier for this job template.
void setInheritResources(Boolean inheritResources)

True if jobs instantiated from this template inherit resources.
void setJobDependencies(Set jobDependencies)

(JobTemplateDependency collection) The list of dependencies for this job template.
void setJobFlags(Set jobFlags)

(JobFlag collection) Job flags for this template.
void setJobTemplateFlags(Set jobTemplateFlags)

(JobTemplateFlag collection) Job template flags for this template.
void setJobTemplateRequirements(Set jobTemplateRequirements)

(JobTemplateRequirement collection) The requirements for this job template.
void setPriority(Long priority)

Relative job priority.
void setQos(String qos)

The Quality of Service for the job.
void setQueue(String queue)

The class or queue in which the job will run.
void setSelect(Boolean select)

True if job template can be directly requested by job at submission.
void setTrigger(Trigger trigger)

The trigger that is typically assigned to generic system jobs.
void setVmUsagePolicy(VMUsagePolicy vmUsagePolicy)

The virtual machine usage policy.
String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

account

private String account
The account under which this job will run for billing purposes.

args

private String args
Command-line arguments that get passed to commandFile.

commandFile

private String commandFile
The path to the file that is executed when the job runs. This is the script that will actually call all the work of the job. Can be null.

description

private String description
The description of the job.

durationRequested

private Long durationRequested
The amount of time (in seconds) requested for the job.

genericSystemJob

private Boolean genericSystemJob
True if this template will instantiate a generic system job.

id

private String id
The unique identifier for this job template.

inheritResources

private Boolean inheritResources
True if jobs instantiated from this template inherit resources.

jobDependencies

private Set jobDependencies
(JobTemplateDependency collection) The list of dependencies for this job template.
See Also:
JobTemplateDependency

jobFlags

private Set jobFlags
(JobFlag collection) Job flags for this template.
See Also:
JobFlag

jobTemplateFlags

private Set jobTemplateFlags
(JobTemplateFlag collection) Job template flags for this template.
See Also:
JobTemplateFlag

jobTemplateRequirements

private Set jobTemplateRequirements
(JobTemplateRequirement collection) The requirements for this job template.
See Also:
JobTemplateRequirement

priority

private Long priority
Relative job priority.

qos

private String qos
The Quality of Service for the job.

queue

private String queue
The class or queue in which the job will run.

select

private Boolean select
True if job template can be directly requested by job at submission.

trigger

private Trigger trigger
The trigger that is typically assigned to generic system jobs.

vmUsagePolicy

private VMUsagePolicy vmUsagePolicy
The virtual machine usage policy.

 
Constructor Detail

JobTemplate

JobTemplate()

 
Method Detail

getAccount

String getAccount()
The account under which this job will run for billing purposes.

getArgs

String getArgs()
Command-line arguments that get passed to commandFile.

getCommandFile

String getCommandFile()
The path to the file that is executed when the job runs. This is the script that will actually call all the work of the job. Can be null.

getDescription

String getDescription()
The description of the job.

getDurationRequested

Long getDurationRequested()
The amount of time (in seconds) requested for the job.

getGenericSystemJob

Boolean getGenericSystemJob()
True if this template will instantiate a generic system job.

getId

String getId()
The unique identifier for this job template.

getInheritResources

Boolean getInheritResources()
True if jobs instantiated from this template inherit resources.

getJobDependencies

Set getJobDependencies()
(JobTemplateDependency collection) The list of dependencies for this job template.
See Also:
JobTemplateDependency

getJobFlags

Set getJobFlags()
(JobFlag collection) Job flags for this template.
See Also:
JobFlag

getJobTemplateFlags

Set getJobTemplateFlags()
(JobTemplateFlag collection) Job template flags for this template.
See Also:
JobTemplateFlag

getJobTemplateRequirements

Set getJobTemplateRequirements()
(JobTemplateRequirement collection) The requirements for this job template.
See Also:
JobTemplateRequirement

getPriority

Long getPriority()
Relative job priority.

getQos

String getQos()
The Quality of Service for the job.

getQueue

String getQueue()
The class or queue in which the job will run.

getSelect

Boolean getSelect()
True if job template can be directly requested by job at submission.

getTrigger

Trigger getTrigger()
The trigger that is typically assigned to generic system jobs.

getVmUsagePolicy

VMUsagePolicy getVmUsagePolicy()
The virtual machine usage policy.

setAccount

void setAccount(String account)
The account under which this job will run for billing purposes.

setArgs

void setArgs(String args)
Command-line arguments that get passed to commandFile.

setCommandFile

void setCommandFile(String commandFile)
The path to the file that is executed when the job runs. This is the script that will actually call all the work of the job. Can be null.

setDescription

void setDescription(String description)
The description of the job.

setDurationRequested

void setDurationRequested(Long durationRequested)
The amount of time (in seconds) requested for the job.

setGenericSystemJob

void setGenericSystemJob(Boolean genericSystemJob)
True if this template will instantiate a generic system job.

setId

void setId(String id)
The unique identifier for this job template.

setInheritResources

void setInheritResources(Boolean inheritResources)
True if jobs instantiated from this template inherit resources.

setJobDependencies

void setJobDependencies(Set jobDependencies)
(JobTemplateDependency collection) The list of dependencies for this job template.
See Also:
JobTemplateDependency

setJobFlags

void setJobFlags(Set jobFlags)
(JobFlag collection) Job flags for this template.
See Also:
JobFlag

setJobTemplateFlags

void setJobTemplateFlags(Set jobTemplateFlags)
(JobTemplateFlag collection) Job template flags for this template.
See Also:
JobTemplateFlag

setJobTemplateRequirements

void setJobTemplateRequirements(Set jobTemplateRequirements)
(JobTemplateRequirement collection) The requirements for this job template.
See Also:
JobTemplateRequirement

setPriority

void setPriority(Long priority)
Relative job priority.

setQos

void setQos(String qos)
The Quality of Service for the job.

setQueue

void setQueue(String queue)
The class or queue in which the job will run.

setSelect

void setSelect(Boolean select)
True if job template can be directly requested by job at submission.

setTrigger

void setTrigger(Trigger trigger)
The trigger that is typically assigned to generic system jobs.

setVmUsagePolicy

void setVmUsagePolicy(VMUsagePolicy vmUsagePolicy)
The virtual machine usage policy.

toString

String toString()

 

Groovy Documentation