Groovy Documentation

com.ace.mws.jobs
[Groovy] Class Job

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 (not yet implemented -- do not use).

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 static long serialVersionUID

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 VirtualContainer virtualContainer

When submitting this job, add it to the specified 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 (not yet implemented -- do not use).

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.

VirtualContainer getVirtualContainer()

When submitting this job, add it to the specified 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 (not yet implemented -- do not use).

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 setVirtualContainer(VirtualContainer virtualContainer)

When submitting this job, add it to the specified 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

account

private String account
The account under which this job runs for billing purposes. Valid during PUT. Valid during POST.


activeDuration

private Long activeDuration
The duration in seconds the job has spent active or running.


allocatedNodes

private Set allocatedNodes
(Node collection) The nodes that are allocated to this job.
See Also:
Node


allocatedVMs

private Set allocatedVMs
(VirtualMachine collection) The list of VMs that are allocated to this job.
See Also:
VirtualMachine


blockReason

private JobBlockReason blockReason
The reason the job is blocked.


bypass

private Integer bypass
The number of times the job has been backfilled.


commandFile

private String commandFile
The path to the file that is executed when the job runs. This is the script that will call all the work of the job. Valid during POST.


commandLineArguments

private String commandLineArguments
The command line arguments passed in when the job is run. Valid during POST.


completionCode

private Integer completionCode
The exit code from the job.


completionDate

private Date completionDate
The date the job completed. If null, the job hasn't completed yet.


dedicatedProcessorSeconds

private Double dedicatedProcessorSeconds
Number of processor seconds dedicated to the job.


dependencies

private Set dependencies
(JobDependency collection) The list of dependencies for this job (not yet implemented -- do not use).
See Also:
JobDependency


destinationRmJobId

private String destinationRmJobId
The ID of the job as known by the destination resource manager.


durationRequested

private Long durationRequested
The amount of time (in seconds) requested for the job. Note that it is possible to set durationRequested to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg. Valid during PUT. Valid during POST.


earliestStartDate

private Date earliestStartDate
Is usually the same as earliestStartDateRequested. Reported by Moab and cannot be changed by the user.


earliestStartDateRequested

private Date earliestStartDateRequested
Used in job creation or modification to set the minimum start time. Valid during PUT. Valid during POST.


effectivePartitionAccessList

private Set effectivePartitionAccessList
(String collection) The list of partitions that this job can access.
See Also:
String


effectiveQueueDuration

private Long effectiveQueueDuration
The duration in seconds the job has been eligible to run in the queue.


emailNotifyTypes

private Set emailNotifyTypes
(JobEmailNotifyType collection) The set of email notify types attached to the job. Valid during POST.
See Also:
JobEmailNotifyType


emailNotifyUsers

private Set emailNotifyUsers
(String collection) The list of users to whom email is sent by the execution server. Valid during POST.
See Also:
String


environmentRequested

private Boolean environmentRequested
Setting this field to true tells Moab to set various variables, if populated, to the job's environment. Valid during POST. Not defined during GET.


environmentVariables

private Map environmentVariables
(Map of String => String) The set of environment variables for this job. Valid during POST.
See Also:
Map


expectedState

private JobState expectedState
The expected state of the job based on scheduler action.


flags

private Set flags
(JobFlag collection) The flags that are set on this job. Valid during PUT. Valid during POST.
See Also:
JobFlag


genericAttributes

private Set genericAttributes
(String collection) The list of generic attributes the job has requested.
See Also:
String


group

private String group
The group under which the job is run. Valid during POST.


holds

private Set holds
(JobHoldType collection) The holds that are set on the job. During POST, only the USER hold type is supported. Valid during PUT. Valid during POST.
See Also:
JobHoldType


hosts

private Set hosts
(String collection) The set of hosts/nodes the job is running on. Valid during POST.
See Also:
String


id

private String id
The unique ID of the job.


initialWorkingDirectory

private String initialWorkingDirectory
The path to the directory in which the job will be started. Valid during POST.


latestCompletedDateRequested

private Date latestCompletedDateRequested
The latest completion date requested by the job.


masterHost

private String masterHost
The node/host that the primary task will run on.


memoryRequested

private Integer memoryRequested
The amount of memory in MB requested by the job.


messages

private Set messages
(Message collection) The list of system and user messages. Valid during PUT.
See Also:
Message


name

private String name
The user-specified name of the job. Valid during PUT. Valid during POST.


os

private String os
The operating system required for the job. Valid during POST.


partitionAccessList

private Set partitionAccessList
(String collection) The list of partitions that this job has requested.
See Also:
String


qos

private String qos
The QoS under which the job is running.


qosRequested

private String qosRequested
The QoS the job requested. This may not be the QoS the job is given based on policies. Valid during PUT. Valid during POST.


queue

private String queue
The class or queue in which the job is running. Valid during PUT. Valid during POST.


queueStatus

private QueueStatus queueStatus
The status of the job in its queue.


requirements

private Set requirements
(JobRequirement collection) The list of items required for this job to run.
See Also:
JobRequirement


reservationRequested

private String reservationRequested
The reservation that the job requested. Valid during PUT. Valid during POST.


reservationStartDate

private Date reservationStartDate
The start date of the reservation in which the job is running.


rmExtension

private String rmExtension
The resource manager extension String that describes information passed to the the resource manager accounting for the job.


rmName

private String rmName
The name of the resource manager that is reporting this job.


rmStandardErrorFilePath

private String rmStandardErrorFilePath
The path to the remote file containing the standard error of the job.


rmStandardInputFilePath

private String rmStandardInputFilePath
The path to the file containing the standard input of the job.


rmStandardOutputFilePath

private String rmStandardOutputFilePath
The path to the file containing the standard output of the job.


runPriority

private Long runPriority
The priority to start running the job.


serialVersionUID

private static final long serialVersionUID


sourceRmJobId

private String sourceRmJobId
The ID of the job as known by the source resource manager.


standardErrorFilePath

private String standardErrorFilePath
The path to the file containing the standard error of the job. Valid during POST.


standardOutputFilePath

private String standardOutputFilePath
The path to the file containing the standard output of the job. Valid during POST.


startCount

private Integer startCount
The number of times the job has been started.


startDate

private Date startDate
The date the job started.


startPriority

private Long startPriority
The priority used when the job is first starting.


state

private JobState state
The job's state.


submitDate

private Date submitDate
The time when this job was submitted to Moab.


submitHost

private String submitHost
The host from which the job was submitted. Valid during POST.


suspendDuration

private Long suspendDuration
The duration for which the job has been suspended.


systemPriority

private Long systemPriority
Administrator-specified system priority level.


templateList

private Set templateList
(String collection) The list of all job templates to be set on this job. Valid during POST. Not defined during GET.
See Also:
String


trigger

private String trigger
Add this trigger to the specified job. Valid during PUT. Not defined during GET.


user

private String user
The user that is running the job. Valid during POST.


userPriority

private Long userPriority
The user-specified priority for the job. Valid during PUT. Valid during POST.


variables

private Map variables
(Map of String => String) The set of variables this job "owns" or sets on completion. Valid during PUT. Valid during POST.
See Also:
Map


virtualContainer

private VirtualContainer virtualContainer
When submitting this job, add it to the specified virtual container. Valid during POST. Not defined during GET.


vmUsagePolicy

private VMUsagePolicy vmUsagePolicy
The requested VM Usage Policy for this job. Valid during POST.


 
Constructor Detail

Job

Job()


 
Method Detail

getAccount

String getAccount()
The account under which this job runs for billing purposes. Valid during PUT. Valid during POST.


getActiveDuration

Long getActiveDuration()
The duration in seconds the job has spent active or running.


getAllocatedNodes

Set getAllocatedNodes()
(Node collection) The nodes that are allocated to this job.
See Also:
Node


getAllocatedVMs

Set getAllocatedVMs()
(VirtualMachine collection) The list of VMs that are allocated to this job.
See Also:
VirtualMachine


getBlockReason

JobBlockReason getBlockReason()
The reason the job is blocked.


getBypass

Integer getBypass()
The number of times the job has been backfilled.


getCommandFile

String getCommandFile()
The path to the file that is executed when the job runs. This is the script that will call all the work of the job. Valid during POST.


getCommandLineArguments

String getCommandLineArguments()
The command line arguments passed in when the job is run. Valid during POST.


getCompletionCode

Integer getCompletionCode()
The exit code from the job.


getCompletionDate

Date getCompletionDate()
The date the job completed. If null, the job hasn't completed yet.


getDedicatedProcessorSeconds

Double getDedicatedProcessorSeconds()
Number of processor seconds dedicated to the job.


getDependencies

Set getDependencies()
(JobDependency collection) The list of dependencies for this job (not yet implemented -- do not use).
See Also:
JobDependency


getDestinationRmJobId

String getDestinationRmJobId()
The ID of the job as known by the destination resource manager.


getDurationRequested

Long getDurationRequested()
The amount of time (in seconds) requested for the job. Note that it is possible to set durationRequested to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg. Valid during PUT. Valid during POST.


getEarliestStartDate

Date getEarliestStartDate()
Is usually the same as earliestStartDateRequested. Reported by Moab and cannot be changed by the user.


getEarliestStartDateRequested

Date getEarliestStartDateRequested()
Used in job creation or modification to set the minimum start time. Valid during PUT. Valid during POST.


getEffectivePartitionAccessList

Set getEffectivePartitionAccessList()
(String collection) The list of partitions that this job can access.
See Also:
String


getEffectiveQueueDuration

Long getEffectiveQueueDuration()
The duration in seconds the job has been eligible to run in the queue.


getEmailNotifyTypes

Set getEmailNotifyTypes()
(JobEmailNotifyType collection) The set of email notify types attached to the job. Valid during POST.
See Also:
JobEmailNotifyType


getEmailNotifyUsers

Set getEmailNotifyUsers()
(String collection) The list of users to whom email is sent by the execution server. Valid during POST.
See Also:
String


getEnvironmentRequested

Boolean getEnvironmentRequested()
Setting this field to true tells Moab to set various variables, if populated, to the job's environment. Valid during POST. Not defined during GET.


getEnvironmentVariables

Map getEnvironmentVariables()
(Map of String => String) The set of environment variables for this job. Valid during POST.
See Also:
Map


getExpectedState

JobState getExpectedState()
The expected state of the job based on scheduler action.


getFlags

Set getFlags()
(JobFlag collection) The flags that are set on this job. Valid during PUT. Valid during POST.
See Also:
JobFlag


getGenericAttributes

Set getGenericAttributes()
(String collection) The list of generic attributes the job has requested.
See Also:
String


getGroup

String getGroup()
The group under which the job is run. Valid during POST.


getHolds

Set getHolds()
(JobHoldType collection) The holds that are set on the job. During POST, only the USER hold type is supported. Valid during PUT. Valid during POST.
See Also:
JobHoldType


getHosts

Set getHosts()
(String collection) The set of hosts/nodes the job is running on. Valid during POST.
See Also:
String


getId

String getId()
The unique ID of the job.


getInitialWorkingDirectory

String getInitialWorkingDirectory()
The path to the directory in which the job will be started. Valid during POST.


getLatestCompletedDateRequested

Date getLatestCompletedDateRequested()
The latest completion date requested by the job.


getMasterHost

String getMasterHost()
The node/host that the primary task will run on.


getMemoryRequested

Integer getMemoryRequested()
The amount of memory in MB requested by the job.


getMessages

Set getMessages()
(Message collection) The list of system and user messages. Valid during PUT.
See Also:
Message


getName

String getName()
The user-specified name of the job. Valid during PUT. Valid during POST.


getOs

String getOs()
The operating system required for the job. Valid during POST.


getPartitionAccessList

Set getPartitionAccessList()
(String collection) The list of partitions that this job has requested.
See Also:
String


getQos

String getQos()
The QoS under which the job is running.


getQosRequested

String getQosRequested()
The QoS the job requested. This may not be the QoS the job is given based on policies. Valid during PUT. Valid during POST.


getQueue

String getQueue()
The class or queue in which the job is running. Valid during PUT. Valid during POST.


getQueueStatus

QueueStatus getQueueStatus()
The status of the job in its queue.


getRequirements

Set getRequirements()
(JobRequirement collection) The list of items required for this job to run.
See Also:
JobRequirement


getReservationRequested

String getReservationRequested()
The reservation that the job requested. Valid during PUT. Valid during POST.


getReservationStartDate

Date getReservationStartDate()
The start date of the reservation in which the job is running.


getRmExtension

String getRmExtension()
The resource manager extension String that describes information passed to the the resource manager accounting for the job.


getRmName

String getRmName()
The name of the resource manager that is reporting this job.


getRmStandardErrorFilePath

String getRmStandardErrorFilePath()
The path to the remote file containing the standard error of the job.


getRmStandardInputFilePath

String getRmStandardInputFilePath()
The path to the file containing the standard input of the job.


getRmStandardOutputFilePath

String getRmStandardOutputFilePath()
The path to the file containing the standard output of the job.


getRunPriority

Long getRunPriority()
The priority to start running the job.


getSourceRmJobId

String getSourceRmJobId()
The ID of the job as known by the source resource manager.


getStandardErrorFilePath

String getStandardErrorFilePath()
The path to the file containing the standard error of the job. Valid during POST.


getStandardOutputFilePath

String getStandardOutputFilePath()
The path to the file containing the standard output of the job. Valid during POST.


getStartCount

Integer getStartCount()
The number of times the job has been started.


getStartDate

Date getStartDate()
The date the job started.


getStartPriority

Long getStartPriority()
The priority used when the job is first starting.


getState

JobState getState()
The job's state.


getSubmitDate

Date getSubmitDate()
The time when this job was submitted to Moab.


getSubmitHost

String getSubmitHost()
The host from which the job was submitted. Valid during POST.


getSuspendDuration

Long getSuspendDuration()
The duration for which the job has been suspended.


getSystemPriority

Long getSystemPriority()
Administrator-specified system priority level.


getTemplateList

Set getTemplateList()
(String collection) The list of all job templates to be set on this job. Valid during POST. Not defined during GET.
See Also:
String


getTrigger

String getTrigger()
Add this trigger to the specified job. Valid during PUT. Not defined during GET.


getUser

String getUser()
The user that is running the job. Valid during POST.


getUserPriority

Long getUserPriority()
The user-specified priority for the job. Valid during PUT. Valid during POST.


getVariables

Map getVariables()
(Map of String => String) The set of variables this job "owns" or sets on completion. Valid during PUT. Valid during POST.
See Also:
Map


getVirtualContainer

VirtualContainer getVirtualContainer()
When submitting this job, add it to the specified virtual container. Valid during POST. Not defined during GET.


getVmUsagePolicy

VMUsagePolicy getVmUsagePolicy()
The requested VM Usage Policy for this job. Valid during POST.


setAccount

void setAccount(String account)
The account under which this job runs for billing purposes. Valid during PUT. Valid during POST.


setActiveDuration

void setActiveDuration(Long activeDuration)
The duration in seconds the job has spent active or running.


setAllocatedNodes

void setAllocatedNodes(Set allocatedNodes)
(Node collection) The nodes that are allocated to this job.
See Also:
Node


setAllocatedVMs

void setAllocatedVMs(Set allocatedVMs)
(VirtualMachine collection) The list of VMs that are allocated to this job.
See Also:
VirtualMachine


setBlockReason

void setBlockReason(JobBlockReason blockReason)
The reason the job is blocked.


setBypass

void setBypass(Integer bypass)
The number of times the job has been backfilled.


setCommandFile

void setCommandFile(String commandFile)
The path to the file that is executed when the job runs. This is the script that will call all the work of the job. Valid during POST.


setCommandLineArguments

void setCommandLineArguments(String commandLineArguments)
The command line arguments passed in when the job is run. Valid during POST.


setCompletionCode

void setCompletionCode(Integer completionCode)
The exit code from the job.


setCompletionDate

void setCompletionDate(Date completionDate)
The date the job completed. If null, the job hasn't completed yet.


setDedicatedProcessorSeconds

void setDedicatedProcessorSeconds(Double dedicatedProcessorSeconds)
Number of processor seconds dedicated to the job.


setDependencies

void setDependencies(Set dependencies)
(JobDependency collection) The list of dependencies for this job (not yet implemented -- do not use).
See Also:
JobDependency


setDestinationRmJobId

void setDestinationRmJobId(String destinationRmJobId)
The ID of the job as known by the destination resource manager.


setDurationRequested

void setDurationRequested(Long durationRequested)
The amount of time (in seconds) requested for the job. Note that it is possible to set durationRequested to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg. Valid during PUT. Valid during POST.


setEarliestStartDate

void setEarliestStartDate(Date earliestStartDate)
Is usually the same as earliestStartDateRequested. Reported by Moab and cannot be changed by the user.


setEarliestStartDateRequested

void setEarliestStartDateRequested(Date earliestStartDateRequested)
Used in job creation or modification to set the minimum start time. Valid during PUT. Valid during POST.


setEffectivePartitionAccessList

void setEffectivePartitionAccessList(Set effectivePartitionAccessList)
(String collection) The list of partitions that this job can access.
See Also:
String


setEffectiveQueueDuration

void setEffectiveQueueDuration(Long effectiveQueueDuration)
The duration in seconds the job has been eligible to run in the queue.


setEmailNotifyTypes

void setEmailNotifyTypes(Set emailNotifyTypes)
(JobEmailNotifyType collection) The set of email notify types attached to the job. Valid during POST.
See Also:
JobEmailNotifyType


setEmailNotifyUsers

void setEmailNotifyUsers(Set emailNotifyUsers)
(String collection) The list of users to whom email is sent by the execution server. Valid during POST.
See Also:
String


setEnvironmentRequested

void setEnvironmentRequested(Boolean environmentRequested)
Setting this field to true tells Moab to set various variables, if populated, to the job's environment. Valid during POST. Not defined during GET.


setEnvironmentVariables

void setEnvironmentVariables(Map environmentVariables)
(Map of String => String) The set of environment variables for this job. Valid during POST.
See Also:
Map


setExpectedState

void setExpectedState(JobState expectedState)
The expected state of the job based on scheduler action.


setFlags

void setFlags(Set flags)
(JobFlag collection) The flags that are set on this job. Valid during PUT. Valid during POST.
See Also:
JobFlag


setGenericAttributes

void setGenericAttributes(Set genericAttributes)
(String collection) The list of generic attributes the job has requested.
See Also:
String


setGroup

void setGroup(String group)
The group under which the job is run. Valid during POST.


setHolds

void setHolds(Set holds)
(JobHoldType collection) The holds that are set on the job. During POST, only the USER hold type is supported. Valid during PUT. Valid during POST.
See Also:
JobHoldType


setHosts

void setHosts(Set hosts)
(String collection) The set of hosts/nodes the job is running on. Valid during POST.
See Also:
String


setId

void setId(String id)
The unique ID of the job.


setInitialWorkingDirectory

void setInitialWorkingDirectory(String initialWorkingDirectory)
The path to the directory in which the job will be started. Valid during POST.


setLatestCompletedDateRequested

void setLatestCompletedDateRequested(Date latestCompletedDateRequested)
The latest completion date requested by the job.


setMasterHost

void setMasterHost(String masterHost)
The node/host that the primary task will run on.


setMemoryRequested

void setMemoryRequested(Integer memoryRequested)
The amount of memory in MB requested by the job.


setMessages

void setMessages(Set messages)
(Message collection) The list of system and user messages. Valid during PUT.
See Also:
Message


setName

void setName(String name)
The user-specified name of the job. Valid during PUT. Valid during POST.


setOs

void setOs(String os)
The operating system required for the job. Valid during POST.


setPartitionAccessList

void setPartitionAccessList(Set partitionAccessList)
(String collection) The list of partitions that this job has requested.
See Also:
String


setQos

void setQos(String qos)
The QoS under which the job is running.


setQosRequested

void setQosRequested(String qosRequested)
The QoS the job requested. This may not be the QoS the job is given based on policies. Valid during PUT. Valid during POST.


setQueue

void setQueue(String queue)
The class or queue in which the job is running. Valid during PUT. Valid during POST.


setQueueStatus

void setQueueStatus(QueueStatus queueStatus)
The status of the job in its queue.


setRequirements

void setRequirements(Set requirements)
(JobRequirement collection) The list of items required for this job to run.
See Also:
JobRequirement


setReservationRequested

void setReservationRequested(String reservationRequested)
The reservation that the job requested. Valid during PUT. Valid during POST.


setReservationStartDate

void setReservationStartDate(Date reservationStartDate)
The start date of the reservation in which the job is running.


setRmExtension

void setRmExtension(String rmExtension)
The resource manager extension String that describes information passed to the the resource manager accounting for the job.


setRmName

void setRmName(String rmName)
The name of the resource manager that is reporting this job.


setRmStandardErrorFilePath

void setRmStandardErrorFilePath(String rmStandardErrorFilePath)
The path to the remote file containing the standard error of the job.


setRmStandardInputFilePath

void setRmStandardInputFilePath(String rmStandardInputFilePath)
The path to the file containing the standard input of the job.


setRmStandardOutputFilePath

void setRmStandardOutputFilePath(String rmStandardOutputFilePath)
The path to the file containing the standard output of the job.


setRunPriority

void setRunPriority(Long runPriority)
The priority to start running the job.


setSourceRmJobId

void setSourceRmJobId(String sourceRmJobId)
The ID of the job as known by the source resource manager.


setStandardErrorFilePath

void setStandardErrorFilePath(String standardErrorFilePath)
The path to the file containing the standard error of the job. Valid during POST.


setStandardOutputFilePath

void setStandardOutputFilePath(String standardOutputFilePath)
The path to the file containing the standard output of the job. Valid during POST.


setStartCount

void setStartCount(Integer startCount)
The number of times the job has been started.


setStartDate

void setStartDate(Date startDate)
The date the job started.


setStartPriority

void setStartPriority(Long startPriority)
The priority used when the job is first starting.


setState

void setState(JobState state)
The job's state.


setSubmitDate

void setSubmitDate(Date submitDate)
The time when this job was submitted to Moab.


setSubmitHost

void setSubmitHost(String submitHost)
The host from which the job was submitted. Valid during POST.


setSuspendDuration

void setSuspendDuration(Long suspendDuration)
The duration for which the job has been suspended.


setSystemPriority

void setSystemPriority(Long systemPriority)
Administrator-specified system priority level.


setTemplateList

void setTemplateList(Set templateList)
(String collection) The list of all job templates to be set on this job. Valid during POST. Not defined during GET.
See Also:
String


setTrigger

void setTrigger(String trigger)
Add this trigger to the specified job. Valid during PUT. Not defined during GET.


setUser

void setUser(String user)
The user that is running the job. Valid during POST.


setUserPriority

void setUserPriority(Long userPriority)
The user-specified priority for the job. Valid during PUT. Valid during POST.


setVariables

void setVariables(Map variables)
(Map of String => String) The set of variables this job "owns" or sets on completion. Valid during PUT. Valid during POST.
See Also:
Map


setVirtualContainer

void setVirtualContainer(VirtualContainer virtualContainer)
When submitting this job, add it to the specified virtual container. Valid during POST. Not defined during GET.


setVmUsagePolicy

void setVmUsagePolicy(VMUsagePolicy vmUsagePolicy)
The requested VM Usage Policy for this job. Valid during POST.


toString

String toString()


 

Groovy Documentation