com.sun.grid.jsv
public final class JobDescription extends java.lang.Object implements java.lang.Cloneable, java.io.Serializable
JsvManager.requestEnvironment(boolean)
,
Serialized FormModifier and Type | Class and Description |
---|---|
static class |
JobDescription.Verification
The possible values for the verification property.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLIENT_CONTEXT
String value of the context property that indicates the JSV is running
on the master node.
|
static java.lang.String |
MASTER_CLIENT
String value of the client property that indicates the JSV is running
on the master node.
|
static java.lang.String |
MASTER_CONTEXT
String value of the context property that indicates the JSV is running
on the master node.
|
Constructor and Description |
---|
JobDescription() |
Modifier and Type | Method and Description |
---|---|
protected JobDescription |
clone() |
java.lang.Boolean |
doNotify()
Get whether the job should be sent warning signals before being suspended
or terminated.
|
java.lang.String |
getAccount()
Get the account string.
|
java.lang.Integer |
getAdvanceReservationId()
Get the advance reservation id.
|
BindingSpecifier |
getBindingSpecifier()
Get the BindingSpecifier object that represents the core vinding
settings for the job.
|
CheckpointSpecifier |
getCheckpointSpecifier()
Get an object representing the checkpointing options.
|
java.lang.String |
getClient()
Get the client string.
|
java.lang.String[] |
getCommandArgs()
Get the arguments to the job.
|
java.lang.String |
getCommandName()
Get the job command.
|
java.lang.String |
getContext()
Get the context string.
|
java.util.Calendar |
getDeadline()
Get the job's deadline time.
|
java.lang.String |
getDisplay()
Get the job's display value.
|
java.util.Map<java.lang.String,java.lang.String> |
getEnvironment()
Get the job's environment variables.
|
java.util.Map<java.lang.String,java.lang.String> |
getErrorPath()
Get the job's error path.
|
java.lang.String |
getGroup()
Get the primary group id for the job's submitter.
|
java.util.List<java.lang.String> |
getHardQueue()
Get the hard queue list.
|
java.util.Map<java.lang.String,java.lang.String> |
getHardResourceRequirements()
Get the hard resource requirements.
|
java.util.List<java.lang.String> |
getHoldArrayJobIds()
Get the list of array job identifiers on which this job's array tasks are
dependent.
|
java.util.List<java.lang.String> |
getHoldJobIds()
Get the list of job identifiers on which this job is dependent.
|
java.util.Map<java.lang.String,java.lang.String> |
getInputPath()
Get the job's input path.
|
java.util.Map<java.lang.String,java.lang.String> |
getJobContext()
Get the job's job context map.
|
java.lang.String |
getJobId()
Get the job's id
|
java.lang.Integer |
getJobShare()
Get the job's assigned functional ticket share.
|
java.util.List<java.lang.String> |
getMailRecipients()
Get the list of email recipients for this job.
|
MailSpecifier |
getMailSpecifier()
Get a MailSpecifier object that represents the occasions when email
notifications should be sent for this job.
|
java.util.List<java.lang.String> |
getMasterQueue()
Get the master queue list.
|
java.lang.String |
getName()
Get the job's name.
|
java.util.Map<java.lang.String,java.lang.String> |
getOutputPath()
Get the job's output path.
|
ParallelEnvironment |
getParallelEnvironment()
Get the ParallelEnvironment object that represents the parallel
environment settings for the job.
|
java.lang.Integer |
getPriority()
Get the job's priority.
|
java.lang.String |
getProject()
Get the job's project
See qsub -P.
|
java.util.Map<java.lang.String,java.lang.String> |
getShellPath()
Get the shell path list.
|
java.util.List<java.lang.String> |
getSoftQueue()
Get the soft queue list.
|
java.util.Map<java.lang.String,java.lang.String> |
getSoftResourceRequirements()
Get the soft resource requirements map.
|
java.util.Calendar |
getStartTime()
Get the job's start time.
|
TaskSpecifier |
getTaskSpecifier()
Get the object that represents the array task specifier.
|
java.lang.String |
getUser()
Get the submitting user.
|
JobDescription.Verification |
getVerification()
Get the verification level.
|
java.lang.String |
getVersion()
Get the JSV framework version.
|
java.lang.String |
getWorkingDirectory()
Get the working directory for the job
See qsub -cwd -wd.
|
java.lang.Boolean |
hasResourceReservation()
Get whether the job uses resource reservation.
|
java.lang.Boolean |
isBinary()
Get whether the job is binary.
|
java.lang.Boolean |
isRerunnable()
Get whether the job can be requeued during execd failure.
|
java.lang.Boolean |
mergeStreams()
Get whether the output and error streams should be written into the same
file.
|
java.lang.Boolean |
onHold()
Get whether the job is submitted in the hold state.
|
void |
setAccount(java.lang.String account)
Set the value of the account string.
|
void |
setAdvanceReservationId(java.lang.Integer advanceReservationId)
Set the value of the advance reservation id.
|
void |
setBinary(java.lang.Boolean binary)
Set whether the job is binary.
|
void |
setBindingSpecifier(BindingSpecifier binding)
Set the BindingSpecifier object that represent's the job to core binding
settings.
|
void |
setCheckpointSpecifier(CheckpointSpecifier checkpointSpecifier)
Set the CheckpointSpecifier object that defines the checkpointing
settings for the job.
|
void |
setCommandArgs(java.lang.String[] commandArgs)
Set the job's command arguments.
|
void |
setDeadline(java.util.Calendar deadline)
Set the deadline time.
|
void |
setDisplay(java.lang.String display)
Set the display string.
|
void |
setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)
Set the job's environment variable.
|
void |
setErrorPath(java.util.Map<java.lang.String,java.lang.String> path)
Set the error path.
|
void |
setHardQueue(java.util.List<java.lang.String> queues)
Set the hard queue list.
|
void |
setHardResourceRequirements(java.util.Map<java.lang.String,java.lang.String> resources)
Set the hard resource requirements map.
|
void |
setHold(java.lang.Boolean hold)
Set whether the job should be submitted in hold state.
|
void |
setHoldArrayJobIds(java.util.List<java.lang.String> jobIds)
Set the list of array job identifiers on which the job tasks depened.
|
void |
setHoldJobIds(java.util.List<java.lang.String> jobIds)
Set the list of job identifiers on which the job depeneds.
|
void |
setInputPath(java.util.Map<java.lang.String,java.lang.String> path)
Set the input path.
|
void |
setJobContext(java.util.Map<java.lang.String,java.lang.String> context)
Set the job's context.
|
void |
setJobShare(java.lang.Integer jobShare)
Set the job's functional ticket share
See qsub -js.
|
void |
setMailRecipients(java.util.List<java.lang.String> recipients)
Set the list of email recipients to be notified on job events.
|
void |
setMailSpecifier(MailSpecifier mailSpecifier)
Set the MailSpecifier object that represents when email notifications
should be sent.
|
void |
setMasterQueue(java.util.List<java.lang.String> queues)
Set the master queue list.
|
void |
setMergeStreams(java.lang.Boolean mergeStreams)
Set whether the output and error streams should be merged.
|
void |
setName(java.lang.String name)
Set the job's name.
|
void |
setNotify(java.lang.Boolean notify)
Set whether the job should be sent warning signals before being
suspended or terminated.
|
void |
setOutputPath(java.util.Map<java.lang.String,java.lang.String> path)
Set the output path.
|
void |
setParallelEnvironment(ParallelEnvironment pe)
Set the ParallelEnvironment object that represent's the job's PE
settings.
|
void |
setPriority(java.lang.Integer priority)
Set the job's priority.
|
void |
setProject(java.lang.String project)
Set the job's project.
|
void |
setRerunnable(java.lang.Boolean rerunnable)
Set whether the job can be requeued in the event of execd failure.
|
void |
setResourceReservation(java.lang.Boolean reservation)
Set whether the job should use resource reservation.
|
void |
setShell(java.lang.Boolean shell)
Set whether the job should be launched by a shell.
|
void |
setShellPath(java.util.Map<java.lang.String,java.lang.String> path)
Set the job's shell path.
|
void |
setSoftQueue(java.util.List<java.lang.String> queues)
Set the job's soft queue list
See qsub -soft -q.
|
void |
setSoftResourceRequirements(java.util.Map<java.lang.String,java.lang.String> resources)
Set the job's soft resource requirements map.
|
void |
setStartTime(java.util.Calendar startTime)
Set the job's start time.
|
void |
setTaskSpecifier(TaskSpecifier taskSpecifier)
Set the TaskSpecifier object that defines the job's array task settings.
|
void |
setVerification(JobDescription.Verification verification)
Set the job's verification level.
|
void |
setWorkingDirectory(java.lang.String cwd)
Set the working directory.
|
java.lang.Boolean |
useShell()
Get whether the job should be launched via a shell.
|
public static final java.lang.String MASTER_CLIENT
getClient()
,
Constant Field Valuespublic static final java.lang.String MASTER_CONTEXT
getContext()
,
Constant Field Valuespublic static final java.lang.String CLIENT_CONTEXT
getContext()
,
Constant Field Valuespublic java.lang.String getAccount()
public java.lang.Integer getAdvanceReservationId()
public CheckpointSpecifier getCheckpointSpecifier()
CheckpointSpecifier
public java.lang.String getClient()
MASTER_CLIENT
public java.lang.String[] getCommandArgs()
public java.lang.String getCommandName()
public java.lang.String getContext()
MASTER_CONTEXT
,
CLIENT_CONTEXT
public java.lang.String getWorkingDirectory()
public java.util.Calendar getDeadline()
public java.lang.String getDisplay()
public java.util.Map<java.lang.String,java.lang.String> getErrorPath()
public java.lang.String getGroup()
public java.util.List<java.lang.String> getHardQueue()
public java.util.Map<java.lang.String,java.lang.String> getHardResourceRequirements()
public java.util.List<java.lang.String> getHoldArrayJobIds()
public java.util.List<java.lang.String> getHoldJobIds()
public java.util.Map<java.lang.String,java.lang.String> getInputPath()
public java.util.Map<java.lang.String,java.lang.String> getJobContext()
public java.lang.String getJobId()
public java.lang.Integer getJobShare()
public java.util.List<java.lang.String> getMailRecipients()
public MailSpecifier getMailSpecifier()
MailSpecifier
public java.util.List<java.lang.String> getMasterQueue()
public java.lang.String getName()
public java.util.Map<java.lang.String,java.lang.String> getOutputPath()
public ParallelEnvironment getParallelEnvironment()
ParallelEnvironment
public BindingSpecifier getBindingSpecifier()
BindingSpecifier
public java.lang.Integer getPriority()
public java.lang.String getProject()
public java.util.Map<java.lang.String,java.lang.String> getShellPath()
public java.util.List<java.lang.String> getSoftQueue()
public java.util.Map<java.lang.String,java.lang.String> getSoftResourceRequirements()
public java.util.Calendar getStartTime()
public TaskSpecifier getTaskSpecifier()
TaskSpecifier
public java.lang.String getUser()
public JobDescription.Verification getVerification()
public java.lang.String getVersion()
public java.lang.Boolean useShell()
public java.lang.Boolean hasResourceReservation()
public java.lang.Boolean isRerunnable()
public java.lang.Boolean doNotify()
public java.lang.Boolean mergeStreams()
public java.lang.Boolean onHold()
public java.lang.Boolean isBinary()
public java.util.Map<java.lang.String,java.lang.String> getEnvironment()
public void setAccount(java.lang.String account)
account
- the account stringpublic void setAdvanceReservationId(java.lang.Integer advanceReservationId)
advanceReservationId
- the advance reservation idpublic void setBinary(java.lang.Boolean binary)
binary
- whether the job is binarypublic void setCheckpointSpecifier(CheckpointSpecifier checkpointSpecifier)
checkpointSpecifier
- the schpoint specifierCheckpointSpecifier
public void setCommandArgs(java.lang.String[] commandArgs)
commandArgs
- the new command argumentspublic void setWorkingDirectory(java.lang.String cwd)
cwd
- the working directorypublic void setDeadline(java.util.Calendar deadline)
deadline
- the deadline timepublic void setDisplay(java.lang.String display)
display
- the display stringpublic void setErrorPath(java.util.Map<java.lang.String,java.lang.String> path)
path
- the error pathpublic void setHardQueue(java.util.List<java.lang.String> queues)
queues
- the hard queue listpublic void setHardResourceRequirements(java.util.Map<java.lang.String,java.lang.String> resources)
resources
- the hard resource requirementspublic void setHold(java.lang.Boolean hold)
hold
- whether the job should be submitted in hold statepublic void setHoldJobIds(java.util.List<java.lang.String> jobIds)
jobIds
- the job dependency listpublic void setHoldArrayJobIds(java.util.List<java.lang.String> jobIds)
jobIds
- the array job dependency listpublic void setInputPath(java.util.Map<java.lang.String,java.lang.String> path)
path
- the error pathpublic void setJobContext(java.util.Map<java.lang.String,java.lang.String> context)
context
- the job contextpublic void setJobShare(java.lang.Integer jobShare)
jobShare
- the job sharepublic void setMailRecipients(java.util.List<java.lang.String> recipients)
recipients
- the email listpublic void setMailSpecifier(MailSpecifier mailSpecifier)
mailSpecifier
- MailSpecifier
public void setMasterQueue(java.util.List<java.lang.String> queues)
queues
- the master queue listpublic void setMergeStreams(java.lang.Boolean mergeStreams)
mergeStreams
- whether to merge the streamspublic void setName(java.lang.String name)
name
- the job namepublic void setNotify(java.lang.Boolean notify)
notify
- whether the job shoud receive warning signalspublic void setOutputPath(java.util.Map<java.lang.String,java.lang.String> path)
path
- the output pathpublic void setParallelEnvironment(ParallelEnvironment pe)
pe
- the job PEParallelEnvironment
public void setBindingSpecifier(BindingSpecifier binding)
binding
- the job bindingBindingSpecifier
public void setPriority(java.lang.Integer priority)
priority
- the job prioritypublic void setProject(java.lang.String project)
project
- the job projectpublic void setRerunnable(java.lang.Boolean rerunnable)
rerunnable
- whether the job can be requeuedpublic void setResourceReservation(java.lang.Boolean reservation)
reservation
- whether the job should use resource reservationpublic void setShell(java.lang.Boolean shell)
shell
- whether the job should use a shellpublic void setShellPath(java.util.Map<java.lang.String,java.lang.String> path)
path
- the shell pathpublic void setSoftQueue(java.util.List<java.lang.String> queues)
queues
- the soft queue listpublic void setSoftResourceRequirements(java.util.Map<java.lang.String,java.lang.String> resources)
resources
- the soft resource requirementspublic void setStartTime(java.util.Calendar startTime)
startTime
- the start timepublic void setTaskSpecifier(TaskSpecifier taskSpecifier)
taskSpecifier
- the task specifierTaskSpecifier
public void setVerification(JobDescription.Verification verification)
verification
- the verification levelpublic void setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)
environment
- the environment variablesprotected JobDescription clone()
clone
in class java.lang.Object