|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ace.mws.jobs.Job
class Job
This class represents a job in the Moab Workload Manager. A job is a request for compute resources (CPUs, memory, storage) with which the requester can do work for a given amount of time. In an HPC environment, this might be a batch script to perform a Monte Carlo simulation. In a cloud environment, this would be a virtual machine and its associated storage. Moab will evaluate the request and assign the requested resources to the requester based on policies, current demand, and other factors in the data center. A job will also usually have some process that Moab starts automatically at the assigned start time. In an HPC environment, this can be starting a batch script on the assigned nodes. In a cloud environment, this can be starting provisioning processes to create the virtual machine and storage and install software on it.
Field Summary | |
---|---|
private String |
account
The account under which this job runs for billing purposes. |
private Long |
activeDuration
The duration in seconds the job has spent active or running. |
private Set |
allocatedNodes
(Node collection) The nodes that are allocated to this job. |
private Set |
allocatedVMs
(VirtualMachine collection) The list of VMs that are allocated to this job. |
private JobBlockReason |
blockReason
The reason the job is blocked. |
private Integer |
bypass
The number of times the job has been backfilled. |
private String |
commandFile
The path to the file that is executed when the job runs. |
private String |
commandLineArguments
The command line arguments passed in when the job is run. |
private Integer |
completionCode
The exit code from the job. |
private Date |
completionDate
The date the job completed. |
private Double |
dedicatedProcessorSeconds
Number of processor seconds dedicated to the job. |
private Set |
dependencies
(JobDependency collection) The list of dependencies for this job. |
private String |
destinationRmJobId
The ID of the job as known by the destination resource manager. |
private Long |
durationRequested
The amount of time (in seconds) requested for the job. |
private Date |
earliestStartDate
Is usually the same as earliestStartDateRequested. |
private Date |
earliestStartDateRequested
Used in job creation or modification to set the minimum start time. |
private Set |
effectivePartitionAccessList
(String collection) The list of partitions that this job can access. |
private Long |
effectiveQueueDuration
The duration in seconds the job has been eligible to run in the queue. |
private Set |
emailNotifyTypes
(JobEmailNotifyType collection) The set of email notify types attached to the job. |
private Set |
emailNotifyUsers
(String collection) The list of users to whom email is sent by the execution server. |
private Boolean |
environmentRequested
Setting this field to true tells Moab to set various variables, if populated, to the job's environment. |
private Map |
environmentVariables
(Map of String => String) The set of environment variables for this job. |
private JobState |
expectedState
The expected state of the job based on scheduler action. |
private Set |
flags
(JobFlag collection) The flags that are set on this job. |
private Set |
genericAttributes
(String collection) The list of generic attributes the job has requested. |
private String |
group
The group under which the job is run. |
private Set |
holds
(JobHoldType collection) The holds that are set on the job. |
private Set |
hosts
(String collection) The set of hosts/nodes the job is running on. |
private String |
id
The unique ID of the job. |
private String |
initialWorkingDirectory
The path to the directory in which the job will be started. |
private Date |
latestCompletedDateRequested
The latest completion date requested by the job. |
private String |
masterHost
The node/host that the primary task will run on. |
private Integer |
memoryRequested
The amount of memory in MB requested by the job. |
private Set |
messages
(Message collection) The list of system and user messages. |
private String |
name
The user-specified name of the job. |
private String |
os
The operating system required for the job. |
private Set |
partitionAccessList
(String collection) The list of partitions that this job has requested. |
private String |
qos
The QoS under which the job is running. |
private String |
qosRequested
The QoS the job requested. |
private String |
queue
The class or queue in which the job is running. |
private QueueStatus |
queueStatus
The status of the job in its queue. |
private Set |
requirements
(JobRequirement collection) The list of items required for this job to run. |
private String |
reservationRequested
The reservation that the job requested. |
private Date |
reservationStartDate
The start date of the reservation in which the job is running. |
private String |
rmExtension
The resource manager extension String that describes information passed to the the resource manager accounting for the job. |
private String |
rmName
The name of the resource manager that is reporting this job. |
private String |
rmStandardErrorFilePath
The path to the remote file containing the standard error of the job. |
private String |
rmStandardInputFilePath
The path to the file containing the standard input of the job. |
private String |
rmStandardOutputFilePath
The path to the file containing the standard output of the job. |
private Long |
runPriority
The priority to start running the job. |
private String |
sourceRmJobId
The ID of the job as known by the source resource manager. |
private String |
standardErrorFilePath
The path to the file containing the standard error of the job. |
private String |
standardOutputFilePath
The path to the file containing the standard output of the job. |
private Integer |
startCount
The number of times the job has been started. |
private Date |
startDate
The date the job started. |
private Long |
startPriority
The priority used when the job is first starting. |
private JobState |
state
The job's state. |
private Date |
submitDate
The time when this job was submitted to Moab. |
private String |
submitHost
The host from which the job was submitted. |
private Long |
suspendDuration
The duration for which the job has been suspended. |
private Long |
systemPriority
Administrator-specified system priority level. |
private Set |
templateList
(String collection) The list of all job templates to be set on this job. |
private String |
trigger
Add this trigger to the specified job. |
private String |
user
The user that is running the job. |
private Long |
userPriority
The user-specified priority for the job. |
private Map |
variables
(Map of String => String) The set of variables this job "owns" or sets on completion. |
private Set |
virtualContainers
(VirtualContainer collection) When submitting this job, add it to the specified existing virtual container. |
private VMUsagePolicy |
vmUsagePolicy
The requested VM Usage Policy for this job. |
Constructor Summary | |
Job()
|
Method Summary | |
---|---|
String
|
getAccount()
The account under which this job runs for billing purposes. |
Long
|
getActiveDuration()
The duration in seconds the job has spent active or running. |
Set
|
getAllocatedNodes()
(Node collection) The nodes that are allocated to this job. |
Set
|
getAllocatedVMs()
(VirtualMachine collection) The list of VMs that are allocated to this job. |
JobBlockReason
|
getBlockReason()
The reason the job is blocked. |
Integer
|
getBypass()
The number of times the job has been backfilled. |
String
|
getCommandFile()
The path to the file that is executed when the job runs. |
String
|
getCommandLineArguments()
The command line arguments passed in when the job is run. |
Integer
|
getCompletionCode()
The exit code from the job. |
Date
|
getCompletionDate()
The date the job completed. |
Double
|
getDedicatedProcessorSeconds()
Number of processor seconds dedicated to the job. |
Set
|
getDependencies()
(JobDependency collection) The list of dependencies for this job. |
String
|
getDestinationRmJobId()
The ID of the job as known by the destination resource manager. |
Long
|
getDurationRequested()
The amount of time (in seconds) requested for the job. |
Date
|
getEarliestStartDate()
Is usually the same as earliestStartDateRequested. |
Date
|
getEarliestStartDateRequested()
Used in job creation or modification to set the minimum start time. |
Set
|
getEffectivePartitionAccessList()
(String collection) The list of partitions that this job can access. |
Long
|
getEffectiveQueueDuration()
The duration in seconds the job has been eligible to run in the queue. |
Set
|
getEmailNotifyTypes()
(JobEmailNotifyType collection) The set of email notify types attached to the job. |
Set
|
getEmailNotifyUsers()
(String collection) The list of users to whom email is sent by the execution server. |
Boolean
|
getEnvironmentRequested()
Setting this field to true tells Moab to set various variables, if populated, to the job's environment. |
Map
|
getEnvironmentVariables()
(Map of String => String) The set of environment variables for this job. |
JobState
|
getExpectedState()
The expected state of the job based on scheduler action. |
Set
|
getFlags()
(JobFlag collection) The flags that are set on this job. |
Set
|
getGenericAttributes()
(String collection) The list of generic attributes the job has requested. |
String
|
getGroup()
The group under which the job is run. |
Set
|
getHolds()
(JobHoldType collection) The holds that are set on the job. |
Set
|
getHosts()
(String collection) The set of hosts/nodes the job is running on. |
String
|
getId()
The unique ID of the job. |
String
|
getInitialWorkingDirectory()
The path to the directory in which the job will be started. |
Date
|
getLatestCompletedDateRequested()
The latest completion date requested by the job. |
String
|
getMasterHost()
The node/host that the primary task will run on. |
Integer
|
getMemoryRequested()
The amount of memory in MB requested by the job. |
Set
|
getMessages()
(Message collection) The list of system and user messages. |
String
|
getName()
The user-specified name of the job. |
String
|
getOs()
The operating system required for the job. |
Set
|
getPartitionAccessList()
(String collection) The list of partitions that this job has requested. |
String
|
getQos()
The QoS under which the job is running. |
String
|
getQosRequested()
The QoS the job requested. |
String
|
getQueue()
The class or queue in which the job is running. |
QueueStatus
|
getQueueStatus()
The status of the job in its queue. |
Set
|
getRequirements()
(JobRequirement collection) The list of items required for this job to run. |
String
|
getReservationRequested()
The reservation that the job requested. |
Date
|
getReservationStartDate()
The start date of the reservation in which the job is running. |
String
|
getRmExtension()
The resource manager extension String that describes information passed to the the resource manager accounting for the job. |
String
|
getRmName()
The name of the resource manager that is reporting this job. |
String
|
getRmStandardErrorFilePath()
The path to the remote file containing the standard error of the job. |
String
|
getRmStandardInputFilePath()
The path to the file containing the standard input of the job. |
String
|
getRmStandardOutputFilePath()
The path to the file containing the standard output of the job. |
Long
|
getRunPriority()
The priority to start running the job. |
String
|
getSourceRmJobId()
The ID of the job as known by the source resource manager. |
String
|
getStandardErrorFilePath()
The path to the file containing the standard error of the job. |
String
|
getStandardOutputFilePath()
The path to the file containing the standard output of the job. |
Integer
|
getStartCount()
The number of times the job has been started. |
Date
|
getStartDate()
The date the job started. |
Long
|
getStartPriority()
The priority used when the job is first starting. |
JobState
|
getState()
The job's state. |
Date
|
getSubmitDate()
The time when this job was submitted to Moab. |
String
|
getSubmitHost()
The host from which the job was submitted. |
Long
|
getSuspendDuration()
The duration for which the job has been suspended. |
Long
|
getSystemPriority()
Administrator-specified system priority level. |
Set
|
getTemplateList()
(String collection) The list of all job templates to be set on this job. |
String
|
getTrigger()
Add this trigger to the specified job. |
String
|
getUser()
The user that is running the job. |
Long
|
getUserPriority()
The user-specified priority for the job. |
Map
|
getVariables()
(Map of String => String) The set of variables this job "owns" or sets on completion. |
Set
|
getVirtualContainers()
(VirtualContainer collection) When submitting this job, add it to the specified existing virtual container. |
VMUsagePolicy
|
getVmUsagePolicy()
The requested VM Usage Policy for this job. |
void
|
setAccount(String account)
The account under which this job runs for billing purposes. |
void
|
setActiveDuration(Long activeDuration)
The duration in seconds the job has spent active or running. |
void
|
setAllocatedNodes(Set allocatedNodes)
(Node collection) The nodes that are allocated to this job. |
void
|
setAllocatedVMs(Set allocatedVMs)
(VirtualMachine collection) The list of VMs that are allocated to this job. |
void
|
setBlockReason(JobBlockReason blockReason)
The reason the job is blocked. |
void
|
setBypass(Integer bypass)
The number of times the job has been backfilled. |
void
|
setCommandFile(String commandFile)
The path to the file that is executed when the job runs. |
void
|
setCommandLineArguments(String commandLineArguments)
The command line arguments passed in when the job is run. |
void
|
setCompletionCode(Integer completionCode)
The exit code from the job. |
void
|
setCompletionDate(Date completionDate)
The date the job completed. |
void
|
setDedicatedProcessorSeconds(Double dedicatedProcessorSeconds)
Number of processor seconds dedicated to the job. |
void
|
setDependencies(Set dependencies)
(JobDependency collection) The list of dependencies for this job. |
void
|
setDestinationRmJobId(String destinationRmJobId)
The ID of the job as known by the destination resource manager. |
void
|
setDurationRequested(Long durationRequested)
The amount of time (in seconds) requested for the job. |
void
|
setEarliestStartDate(Date earliestStartDate)
Is usually the same as earliestStartDateRequested. |
void
|
setEarliestStartDateRequested(Date earliestStartDateRequested)
Used in job creation or modification to set the minimum start time. |
void
|
setEffectivePartitionAccessList(Set effectivePartitionAccessList)
(String collection) The list of partitions that this job can access. |
void
|
setEffectiveQueueDuration(Long effectiveQueueDuration)
The duration in seconds the job has been eligible to run in the queue. |
void
|
setEmailNotifyTypes(Set emailNotifyTypes)
(JobEmailNotifyType collection) The set of email notify types attached to the job. |
void
|
setEmailNotifyUsers(Set emailNotifyUsers)
(String collection) The list of users to whom email is sent by the execution server. |
void
|
setEnvironmentRequested(Boolean environmentRequested)
Setting this field to true tells Moab to set various variables, if populated, to the job's environment. |
void
|
setEnvironmentVariables(Map environmentVariables)
(Map of String => String) The set of environment variables for this job. |
void
|
setExpectedState(JobState expectedState)
The expected state of the job based on scheduler action. |
void
|
setFlags(Set flags)
(JobFlag collection) The flags that are set on this job. |
void
|
setGenericAttributes(Set genericAttributes)
(String collection) The list of generic attributes the job has requested. |
void
|
setGroup(String group)
The group under which the job is run. |
void
|
setHolds(Set holds)
(JobHoldType collection) The holds that are set on the job. |
void
|
setHosts(Set hosts)
(String collection) The set of hosts/nodes the job is running on. |
void
|
setId(String id)
The unique ID of the job. |
void
|
setInitialWorkingDirectory(String initialWorkingDirectory)
The path to the directory in which the job will be started. |
void
|
setLatestCompletedDateRequested(Date latestCompletedDateRequested)
The latest completion date requested by the job. |
void
|
setMasterHost(String masterHost)
The node/host that the primary task will run on. |
void
|
setMemoryRequested(Integer memoryRequested)
The amount of memory in MB requested by the job. |
void
|
setMessages(Set messages)
(Message collection) The list of system and user messages. |
void
|
setName(String name)
The user-specified name of the job. |
void
|
setOs(String os)
The operating system required for the job. |
void
|
setPartitionAccessList(Set partitionAccessList)
(String collection) The list of partitions that this job has requested. |
void
|
setQos(String qos)
The QoS under which the job is running. |
void
|
setQosRequested(String qosRequested)
The QoS the job requested. |
void
|
setQueue(String queue)
The class or queue in which the job is running. |
void
|
setQueueStatus(QueueStatus queueStatus)
The status of the job in its queue. |
void
|
setRequirements(Set requirements)
(JobRequirement collection) The list of items required for this job to run. |
void
|
setReservationRequested(String reservationRequested)
The reservation that the job requested. |
void
|
setReservationStartDate(Date reservationStartDate)
The start date of the reservation in which the job is running. |
void
|
setRmExtension(String rmExtension)
The resource manager extension String that describes information passed to the the resource manager accounting for the job. |
void
|
setRmName(String rmName)
The name of the resource manager that is reporting this job. |
void
|
setRmStandardErrorFilePath(String rmStandardErrorFilePath)
The path to the remote file containing the standard error of the job. |
void
|
setRmStandardInputFilePath(String rmStandardInputFilePath)
The path to the file containing the standard input of the job. |
void
|
setRmStandardOutputFilePath(String rmStandardOutputFilePath)
The path to the file containing the standard output of the job. |
void
|
setRunPriority(Long runPriority)
The priority to start running the job. |
void
|
setSourceRmJobId(String sourceRmJobId)
The ID of the job as known by the source resource manager. |
void
|
setStandardErrorFilePath(String standardErrorFilePath)
The path to the file containing the standard error of the job. |
void
|
setStandardOutputFilePath(String standardOutputFilePath)
The path to the file containing the standard output of the job. |
void
|
setStartCount(Integer startCount)
The number of times the job has been started. |
void
|
setStartDate(Date startDate)
The date the job started. |
void
|
setStartPriority(Long startPriority)
The priority used when the job is first starting. |
void
|
setState(JobState state)
The job's state. |
void
|
setSubmitDate(Date submitDate)
The time when this job was submitted to Moab. |
void
|
setSubmitHost(String submitHost)
The host from which the job was submitted. |
void
|
setSuspendDuration(Long suspendDuration)
The duration for which the job has been suspended. |
void
|
setSystemPriority(Long systemPriority)
Administrator-specified system priority level. |
void
|
setTemplateList(Set templateList)
(String collection) The list of all job templates to be set on this job. |
void
|
setTrigger(String trigger)
Add this trigger to the specified job. |
void
|
setUser(String user)
The user that is running the job. |
void
|
setUserPriority(Long userPriority)
The user-specified priority for the job. |
void
|
setVariables(Map variables)
(Map of String => String) The set of variables this job "owns" or sets on completion. |
void
|
setVirtualContainers(Set virtualContainers)
(VirtualContainer collection) When submitting this job, add it to the specified existing virtual container. |
void
|
setVmUsagePolicy(VMUsagePolicy vmUsagePolicy)
The requested VM Usage Policy for this job. |
String
|
toString()
|
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Field Detail |
---|
private String account
private Long activeDuration
private Set allocatedNodes
private Set allocatedVMs
private JobBlockReason blockReason
private Integer bypass
private String commandFile
private String commandLineArguments
private Integer completionCode
private Date completionDate
private Double dedicatedProcessorSeconds
private Set dependencies
private String destinationRmJobId
private Long durationRequested
private Date earliestStartDate
private Date earliestStartDateRequested
private Set effectivePartitionAccessList
private Long effectiveQueueDuration
private Set emailNotifyTypes
private Set emailNotifyUsers
private Boolean environmentRequested
private Map environmentVariables
private JobState expectedState
private Set flags
private Set genericAttributes
private String group
private Set holds
private Set hosts
private String id
private String initialWorkingDirectory
private Date latestCompletedDateRequested
private String masterHost
private Integer memoryRequested
private Set messages
private String name
private String os
private Set partitionAccessList
private String qos
private String qosRequested
private String queue
private QueueStatus queueStatus
private Set requirements
private String reservationRequested
private Date reservationStartDate
private String rmExtension
private String rmName
private String rmStandardErrorFilePath
private String rmStandardInputFilePath
private String rmStandardOutputFilePath
private Long runPriority
private String sourceRmJobId
private String standardErrorFilePath
private String standardOutputFilePath
private Integer startCount
private Date startDate
private Long startPriority
private JobState state
private Date submitDate
private String submitHost
private Long suspendDuration
private Long systemPriority
private Set templateList
private String trigger
private String user
private Long userPriority
private Map variables
private Set virtualContainers
private VMUsagePolicy vmUsagePolicy
Constructor Detail |
---|
Job()
Method Detail |
---|
String getAccount()
Long getActiveDuration()
Set getAllocatedNodes()
Set getAllocatedVMs()
JobBlockReason getBlockReason()
Integer getBypass()
String getCommandFile()
String getCommandLineArguments()
Integer getCompletionCode()
Date getCompletionDate()
Double getDedicatedProcessorSeconds()
Set getDependencies()
String getDestinationRmJobId()
Long getDurationRequested()
Date getEarliestStartDate()
Date getEarliestStartDateRequested()
Set getEffectivePartitionAccessList()
Long getEffectiveQueueDuration()
Set getEmailNotifyTypes()
Set getEmailNotifyUsers()
Boolean getEnvironmentRequested()
Map getEnvironmentVariables()
JobState getExpectedState()
Set getFlags()
Set getGenericAttributes()
String getGroup()
Set getHolds()
Set getHosts()
String getId()
String getInitialWorkingDirectory()
Date getLatestCompletedDateRequested()
String getMasterHost()
Integer getMemoryRequested()
Set getMessages()
String getName()
String getOs()
Set getPartitionAccessList()
String getQos()
String getQosRequested()
String getQueue()
QueueStatus getQueueStatus()
Set getRequirements()
String getReservationRequested()
Date getReservationStartDate()
String getRmExtension()
String getRmName()
String getRmStandardErrorFilePath()
String getRmStandardInputFilePath()
String getRmStandardOutputFilePath()
Long getRunPriority()
String getSourceRmJobId()
String getStandardErrorFilePath()
String getStandardOutputFilePath()
Integer getStartCount()
Date getStartDate()
Long getStartPriority()
JobState getState()
Date getSubmitDate()
String getSubmitHost()
Long getSuspendDuration()
Long getSystemPriority()
Set getTemplateList()
String getTrigger()
String getUser()
Long getUserPriority()
Map getVariables()
Set getVirtualContainers()
VMUsagePolicy getVmUsagePolicy()
void setAccount(String account)
void setActiveDuration(Long activeDuration)
void setAllocatedNodes(Set allocatedNodes)
void setAllocatedVMs(Set allocatedVMs)
void setBlockReason(JobBlockReason blockReason)
void setBypass(Integer bypass)
void setCommandFile(String commandFile)
void setCommandLineArguments(String commandLineArguments)
void setCompletionCode(Integer completionCode)
void setCompletionDate(Date completionDate)
void setDedicatedProcessorSeconds(Double dedicatedProcessorSeconds)
void setDependencies(Set dependencies)
void setDestinationRmJobId(String destinationRmJobId)
void setDurationRequested(Long durationRequested)
void setEarliestStartDate(Date earliestStartDate)
void setEarliestStartDateRequested(Date earliestStartDateRequested)
void setEffectivePartitionAccessList(Set effectivePartitionAccessList)
void setEffectiveQueueDuration(Long effectiveQueueDuration)
void setEmailNotifyTypes(Set emailNotifyTypes)
void setEmailNotifyUsers(Set emailNotifyUsers)
void setEnvironmentRequested(Boolean environmentRequested)
void setEnvironmentVariables(Map environmentVariables)
void setExpectedState(JobState expectedState)
void setFlags(Set flags)
void setGenericAttributes(Set genericAttributes)
void setGroup(String group)
void setHolds(Set holds)
void setHosts(Set hosts)
void setId(String id)
void setInitialWorkingDirectory(String initialWorkingDirectory)
void setLatestCompletedDateRequested(Date latestCompletedDateRequested)
void setMasterHost(String masterHost)
void setMemoryRequested(Integer memoryRequested)
void setMessages(Set messages)
void setName(String name)
void setOs(String os)
void setPartitionAccessList(Set partitionAccessList)
void setQos(String qos)
void setQosRequested(String qosRequested)
void setQueue(String queue)
void setQueueStatus(QueueStatus queueStatus)
void setRequirements(Set requirements)
void setReservationRequested(String reservationRequested)
void setReservationStartDate(Date reservationStartDate)
void setRmExtension(String rmExtension)
void setRmName(String rmName)
void setRmStandardErrorFilePath(String rmStandardErrorFilePath)
void setRmStandardInputFilePath(String rmStandardInputFilePath)
void setRmStandardOutputFilePath(String rmStandardOutputFilePath)
void setRunPriority(Long runPriority)
void setSourceRmJobId(String sourceRmJobId)
void setStandardErrorFilePath(String standardErrorFilePath)
void setStandardOutputFilePath(String standardOutputFilePath)
void setStartCount(Integer startCount)
void setStartDate(Date startDate)
void setStartPriority(Long startPriority)
void setState(JobState state)
void setSubmitDate(Date submitDate)
void setSubmitHost(String submitHost)
void setSuspendDuration(Long suspendDuration)
void setSystemPriority(Long systemPriority)
void setTemplateList(Set templateList)
void setTrigger(String trigger)
void setUser(String user)
void setUserPriority(Long userPriority)
void setVariables(Map variables)
void setVirtualContainers(Set virtualContainers)
void setVmUsagePolicy(VMUsagePolicy vmUsagePolicy)
String toString()
Groovy Documentation