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.

arrayIndex

private Long arrayIndex

If this job is a sub-job of a JobArray, this field contains the index of this job in the array. For example, if this job is Moab.1[2], the array index would be 2.

arrayMasterName

private String arrayMasterName

If this job is a sub-job of a JobArray, this field contains the name of the job array master. For example, if this job is Moab.1[2], the array master name would be Moab.1.

attributes

private Set attributes

(String collection) The list of generic attributes associated with this job. Valid during POST.

See Also:

String

blocks

private Set blocks

(JobBlock collection) Reasons the job is blocked from running.

See Also:

JobBlock

bypassCount

private Integer bypassCount

The number of times the job has been backfilled.

cancelCount

private Integer cancelCount

The number of times a job has received a cancel request.

commandFile

private String commandFile

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

commandLineArguments

private String commandLineArguments

The command line arguments passed to the commandFile. Valid during POST.

completionCode

private Integer completionCode

The exit code from this job.

cpuTime

private Long cpuTime

CPU usage time in seconds as reported by the resource manager.

credentials

private JobCredentials credentials

The credentials (user and group, for example) associated with this job. Some fields are valid during POST. Some fields are valid during PUT.

customName

private String customName

The user-specified name of this job. Valid during POST. Valid during PUT.

dates

private JobDates dates

Various dates associated with this job. Some fields are valid during POST. Some fields are valid during PUT.

deferCount

private Integer deferCount

The number of times a job has been deferred.

dependencies

private Set dependencies

(JobDependency collection)

description

private String description

The description of the job. Can be set only in a job template.

duration

private Long duration

The length of time in seconds requested for the job. Note that it is possible to set duration to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg. Valid during POST. Valid during PUT.

durationActive

private Long durationActive

The length of time in seconds the job has been active or running.

durationQueued

private Long durationQueued

The length of time in seconds the job has been eligible to run in the queue.

durationRemaining

private Long durationRemaining

An estimate of the time remaining, in seconds, before the job will complete.

durationSuspended

private Long durationSuspended

The length of time in seconds the job has been suspended.

emailNotifyAddresses

private Set emailNotifyAddresses

(String collection) The list of addresses to whom email is sent by the execution server. Valid during POST.

See Also:

String

emailNotifyTypes

private Set emailNotifyTypes

(JobEmailNotifyType collection) The list of email notify types attached to the job. Valid during POST.

See Also:

JobEmailNotifyType

environmentRequested

private Boolean environmentRequested

Setting this field to true tells the Moab Workload Manager to set various variables, if populated, in the job's environment. Valid during POST.

environmentVariables

private Map environmentVariables

(Map of String => String) The list of environment variables for this job. Valid during POST.

See Also:

Map

epilogScript

private String epilogScript

The path to the TORQUE epilog script. Valid during POST.

flags

private Set flags

(JobFlag collection) The flags that are set on this job. Valid during POST. Valid during PUT.

See Also:

JobFlag

holdDate

private Date holdDate

The date the most recent hold was placed on the job.

holdReason

private JobHoldReason holdReason

The reason the job is on hold.

holds

private Set holds

(JobHoldType collection) The holds that are set on the job. The "User" hold type is valid during POST. Valid during PUT.

See Also:

JobHoldType

id

private String id

The unique identifier of this job. Note: this field is not user-assigned and is generated by the database.

initialWorkingDirectory

private String initialWorkingDirectory

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

isActive

private Boolean isActive

True if the job is active, false if the job is complete.

jobGroup

private String jobGroup

The job group to which this job belongs (different from credentials.group). Valid during POST.

masterNode

private DomainProxy masterNode

The first node in the list of allocated nodes for this job. For TORQUE jobs, this represents the "mother superior."

memorySecondsDedicated

private Double memorySecondsDedicated

The memory seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.

memorySecondsUtilized

private Double memorySecondsUtilized

The memory seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.

messages

private Set messages

(Message collection) The list of messages associated with the job. The "message" field is valid during PUT.

See Also:

Message

migrateCount

private Integer migrateCount

The number of times the job has been migrated.

minimumPreemptTime

private Long minimumPreemptTime

The minimum length of time, in seconds, an active job must be running before it is eligible for preemption.

mwmName

private String mwmName

The name of the Moab Workload Manager instance that owns this job.

name

private String name

The name of this job. This name is unique per instance of Moab Workload Manager (i.e. not globally).

nodesExcluded

private Set nodesExcluded

(DomainProxy collection) The list of nodes that should not be considered for this job. Valid during POST.

See Also:

DomainProxy

nodesRequested

private Set nodesRequested

(DomainProxy collection) The exact set, superset, or subset of nodes on which this job must run. Valid during POST.

See Also:

nodesRequestedPolicy

DomainProxy

nodesRequestedPolicy

private JobHostListMode nodesRequestedPolicy

Indicates an exact set, superset, or subset of nodes on which the job must run. Only relevant if nodesRequested is provided. Valid during POST.

See Also:

nodesRequested

partitionAccessList

private Set partitionAccessList

(String collection) The list of partitions that this job can access.

See Also:

String

partitionAccessListRequested

private Set partitionAccessListRequested

(String collection) The list of partitions that this job has requested. Valid during POST. Valid during PUT.

See Also:

String

preemptCount

private Integer preemptCount

The number of times the job has been preempted.

priorities

private JobPriority priorities

The list of priorities for the job. The "user" field is valid during POST. The "user" field is valid during PUT.

processorSecondsDedicated

private Double processorSecondsDedicated

The processor seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.

processorSecondsLimit

private Double processorSecondsLimit

The limit for processorSecondsUtilized.

processorSecondsUtilized

private Double processorSecondsUtilized

The processor seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.

prologScript

private String prologScript

The path to the TORQUE prolog script. Valid during POST.

queueStatus

private JobQueueStatus queueStatus

The status of the job in its queue.

rejectPolicies

private Set rejectPolicies

(JobRejectPolicy collection) The list of policies enabled when a job is rejected.

See Also:

JobRejectPolicy

requirements

private Set requirements

(JobRequirement collection) The list of items required for this job to run. Some fields are valid during POST.

See Also:

JobRequirement

reservationRequested

private DomainProxy reservationRequested

The reservation that the job requested. Valid during POST. Valid during PUT.

resourceFailPolicy

private JobResourceFailPolicyType resourceFailPolicy

The policy that dictates what should happen to the job if it is running and at least one of the resources it is using fails. Valid during POST.

resourceManagerExtension

private String resourceManagerExtension

If provided during POST, this string will be added to the resource manager extension section of the job submission. Example: "bandwidth=120;queuejob=false"
Note that the delimiter between resourceManagerExtension elements is the semicolon. Valid during POST.

resourceManagers

private Set resourceManagers

(ResourceManager collection) The list of resource managers associated with this job.

See Also:

ResourceManager

rmStandardErrorFilePath

private String rmStandardErrorFilePath

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

rmStandardOutputFilePath

private String rmStandardOutputFilePath

The path to the remote file containing the standard output of the job.

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.

states

private JobStateInformation states

Information about the state of the job.

submitHost

private String submitHost

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

systemJobAction

private String systemJobAction

The action the system job will take.

systemJobType

private JobSystemJobType systemJobType

The type of system job. In the Moab Cloud Suite, this will usually be "vmtracking" or "generic."

targetedJobAction

private JobActionType targetedJobAction

The action that this job is performing on another job.

targetedJobName

private String targetedJobName

The name of the job on which this job is performing the targetedJobAction.

templates

private Set templates

(DomainProxy collection) The list of all job templates to be set on this job. Valid during POST.

See Also:

DomainProxy

triggers

private Set triggers

(String collection) The list of triggers associated with this job.

See Also:

String

variables

private Map variables

(Map of String => String) The list of variables that this job owns or sets on completion. Valid during POST. Valid during PUT.

See Also:

Map

virtualContainers

private Set virtualContainers

(DomainProxy collection) When submitting this job, add it to the specified existing virtual container. Valid during POST, but only one virtual container can be specified.

See Also:

DomainProxy

virtualMachines

private Set virtualMachines

(DomainProxy collection) The list of virtual machines that are allocated to this job.

See Also:

DomainProxy

vmUsagePolicy

private VMUsagePolicy vmUsagePolicy

The requested Virtual Machine Usage Policy for this job. Valid during POST.

Job

Job()

getArrayIndex

Long getArrayIndex()

If this job is a sub-job of a JobArray, this field contains the index of this job in the array. For example, if this job is Moab.1[2], the array index would be 2.

getArrayMasterName

String getArrayMasterName()

If this job is a sub-job of a JobArray, this field contains the name of the job array master. For example, if this job is Moab.1[2], the array master name would be Moab.1.

getAttributes

Set getAttributes()

(String collection) The list of generic attributes associated with this job. Valid during POST.

See Also:

String

getBlocks

Set getBlocks()

(JobBlock collection) Reasons the job is blocked from running.

See Also:

JobBlock

getBypassCount

Integer getBypassCount()

The number of times the job has been backfilled.

getCancelCount

Integer getCancelCount()

The number of times a job has received a cancel request.

getCommandFile

String getCommandFile()

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

getCommandLineArguments

String getCommandLineArguments()

The command line arguments passed to the commandFile. Valid during POST.

getCompletionCode

Integer getCompletionCode()

The exit code from this job.

getCpuTime

Long getCpuTime()

CPU usage time in seconds as reported by the resource manager.

getCredentials

JobCredentials getCredentials()

The credentials (user and group, for example) associated with this job. Some fields are valid during POST. Some fields are valid during PUT.

getCustomName

String getCustomName()

The user-specified name of this job. Valid during POST. Valid during PUT.

getDates

JobDates getDates()

Various dates associated with this job. Some fields are valid during POST. Some fields are valid during PUT.

getDeferCount

Integer getDeferCount()

The number of times a job has been deferred.

getDependencies

Set getDependencies()

(JobDependency collection)

getDescription

String getDescription()

The description of the job. Can be set only in a job template.

getDuration

Long getDuration()

The length of time in seconds requested for the job. Note that it is possible to set duration to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg. Valid during POST. Valid during PUT.

getDurationActive

Long getDurationActive()

The length of time in seconds the job has been active or running.

getDurationQueued

Long getDurationQueued()

The length of time in seconds the job has been eligible to run in the queue.

getDurationRemaining

Long getDurationRemaining()

An estimate of the time remaining, in seconds, before the job will complete.

getDurationSuspended

Long getDurationSuspended()

The length of time in seconds the job has been suspended.

getEmailNotifyAddresses

Set getEmailNotifyAddresses()

(String collection) The list of addresses to whom email is sent by the execution server. Valid during POST.

See Also:

String

getEmailNotifyTypes

Set getEmailNotifyTypes()

(JobEmailNotifyType collection) The list of email notify types attached to the job. Valid during POST.

See Also:

JobEmailNotifyType

getEnvironmentRequested

Boolean getEnvironmentRequested()

Setting this field to true tells the Moab Workload Manager to set various variables, if populated, in the job's environment. Valid during POST.

getEnvironmentVariables

Map getEnvironmentVariables()

(Map of String => String) The list of environment variables for this job. Valid during POST.

See Also:

Map

getEpilogScript

String getEpilogScript()

The path to the TORQUE epilog script. Valid during POST.

getFlags

Set getFlags()

(JobFlag collection) The flags that are set on this job. Valid during POST. Valid during PUT.

See Also:

JobFlag

getHoldDate

Date getHoldDate()

The date the most recent hold was placed on the job.

getHoldReason

JobHoldReason getHoldReason()

The reason the job is on hold.

getHolds

Set getHolds()

(JobHoldType collection) The holds that are set on the job. The "User" hold type is valid during POST. Valid during PUT.

See Also:

JobHoldType

getId

String getId()

The unique identifier of this job. Note: this field is not user-assigned and is generated by the database.

getInitialWorkingDirectory

String getInitialWorkingDirectory()

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

getIsActive

Boolean getIsActive()

True if the job is active, false if the job is complete.

getJobGroup

String getJobGroup()

The job group to which this job belongs (different from credentials.group). Valid during POST.

getMasterNode

DomainProxy getMasterNode()

The first node in the list of allocated nodes for this job. For TORQUE jobs, this represents the "mother superior."

getMemorySecondsDedicated

Double getMemorySecondsDedicated()

The memory seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.

getMemorySecondsUtilized

Double getMemorySecondsUtilized()

The memory seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.

getMessages

Set getMessages()

(Message collection) The list of messages associated with the job. The "message" field is valid during PUT.

See Also:

Message

getMigrateCount

Integer getMigrateCount()

The number of times the job has been migrated.

getMinimumPreemptTime

Long getMinimumPreemptTime()

The minimum length of time, in seconds, an active job must be running before it is eligible for preemption.

getMwmName

String getMwmName()

The name of the Moab Workload Manager instance that owns this job.

getName

String getName()

The name of this job. This name is unique per instance of Moab Workload Manager (i.e. not globally).

getNodesExcluded

Set getNodesExcluded()

(DomainProxy collection) The list of nodes that should not be considered for this job. Valid during POST.

See Also:

DomainProxy

getNodesRequested

Set getNodesRequested()

(DomainProxy collection) The exact set, superset, or subset of nodes on which this job must run. Valid during POST.

See Also:

nodesRequestedPolicy

DomainProxy

getNodesRequestedPolicy

JobHostListMode getNodesRequestedPolicy()

Indicates an exact set, superset, or subset of nodes on which the job must run. Only relevant if nodesRequested is provided. Valid during POST.

See Also:

nodesRequested

getPartitionAccessList

Set getPartitionAccessList()

(String collection) The list of partitions that this job can access.

See Also:

String

getPartitionAccessListRequested

Set getPartitionAccessListRequested()

(String collection) The list of partitions that this job has requested. Valid during POST. Valid during PUT.

See Also:

String

getPreemptCount

Integer getPreemptCount()

The number of times the job has been preempted.

getPriorities

JobPriority getPriorities()

The list of priorities for the job. The "user" field is valid during POST. The "user" field is valid during PUT.

getProcessorSecondsDedicated

Double getProcessorSecondsDedicated()

The processor seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.

getProcessorSecondsLimit

Double getProcessorSecondsLimit()

The limit for processorSecondsUtilized.

getProcessorSecondsUtilized

Double getProcessorSecondsUtilized()

The processor seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.

getPrologScript

String getPrologScript()

The path to the TORQUE prolog script. Valid during POST.

getQueueStatus

JobQueueStatus getQueueStatus()

The status of the job in its queue.

getRejectPolicies

Set getRejectPolicies()

(JobRejectPolicy collection) The list of policies enabled when a job is rejected.

See Also:

JobRejectPolicy

getRequirements

Set getRequirements()

(JobRequirement collection) The list of items required for this job to run. Some fields are valid during POST.

See Also:

JobRequirement

getReservationRequested

DomainProxy getReservationRequested()

The reservation that the job requested. Valid during POST. Valid during PUT.

getResourceFailPolicy

JobResourceFailPolicyType getResourceFailPolicy()

The policy that dictates what should happen to the job if it is running and at least one of the resources it is using fails. Valid during POST.

getResourceManagerExtension

String getResourceManagerExtension()

If provided during POST, this string will be added to the resource manager extension section of the job submission. Example: "bandwidth=120;queuejob=false"
Note that the delimiter between resourceManagerExtension elements is the semicolon. Valid during POST.

getResourceManagers

Set getResourceManagers()

(ResourceManager collection) The list of resource managers associated with this job.

See Also:

ResourceManager

getRmStandardErrorFilePath

String getRmStandardErrorFilePath()

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

getRmStandardOutputFilePath

String getRmStandardOutputFilePath()

The path to the remote file containing the standard output of the job.

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.

getStates

JobStateInformation getStates()

Information about the state of the job.

getSubmitHost

String getSubmitHost()

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

getSystemJobAction

String getSystemJobAction()

The action the system job will take.

getSystemJobType

JobSystemJobType getSystemJobType()

The type of system job. In the Moab Cloud Suite, this will usually be "vmtracking" or "generic."

getTargetedJobAction

JobActionType getTargetedJobAction()

The action that this job is performing on another job.

getTargetedJobName

String getTargetedJobName()

The name of the job on which this job is performing the targetedJobAction.

getTemplates

Set getTemplates()

(DomainProxy collection) The list of all job templates to be set on this job. Valid during POST.

See Also:

DomainProxy

getTriggers

Set getTriggers()

(String collection) The list of triggers associated with this job.

See Also:

String

getVariables

Map getVariables()

(Map of String => String) The list of variables that this job owns or sets on completion. Valid during POST. Valid during PUT.

See Also:

Map

getVirtualContainers

Set getVirtualContainers()

(DomainProxy collection) When submitting this job, add it to the specified existing virtual container. Valid during POST, but only one virtual container can be specified.

See Also:

DomainProxy

getVirtualMachines

Set getVirtualMachines()

(DomainProxy collection) The list of virtual machines that are allocated to this job.

See Also:

DomainProxy

getVmUsagePolicy

VMUsagePolicy getVmUsagePolicy()

The requested Virtual Machine Usage Policy for this job. Valid during POST.

setArrayIndex

void setArrayIndex(Long arrayIndex)

If this job is a sub-job of a JobArray, this field contains the index of this job in the array. For example, if this job is Moab.1[2], the array index would be 2.

setArrayMasterName

void setArrayMasterName(String arrayMasterName)

If this job is a sub-job of a JobArray, this field contains the name of the job array master. For example, if this job is Moab.1[2], the array master name would be Moab.1.

setAttributes

void setAttributes(Set attributes)

(String collection) The list of generic attributes associated with this job. Valid during POST.

See Also:

String

setBlocks

void setBlocks(Set blocks)

(JobBlock collection) Reasons the job is blocked from running.

See Also:

JobBlock

setBypassCount

void setBypassCount(Integer bypassCount)

The number of times the job has been backfilled.

setCancelCount

void setCancelCount(Integer cancelCount)

The number of times a job has received a cancel request.

setCommandFile

void setCommandFile(String commandFile)

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

setCommandLineArguments

void setCommandLineArguments(String commandLineArguments)

The command line arguments passed to the commandFile. Valid during POST.

setCompletionCode

void setCompletionCode(Integer completionCode)

The exit code from this job.

setCpuTime

void setCpuTime(Long cpuTime)

CPU usage time in seconds as reported by the resource manager.

setCredentials

void setCredentials(JobCredentials credentials)

The credentials (user and group, for example) associated with this job. Some fields are valid during POST. Some fields are valid during PUT.

setCustomName

void setCustomName(String customName)

The user-specified name of this job. Valid during POST. Valid during PUT.

setDates

void setDates(JobDates dates)

Various dates associated with this job. Some fields are valid during POST. Some fields are valid during PUT.

setDeferCount

void setDeferCount(Integer deferCount)

The number of times a job has been deferred.

setDependencies

void setDependencies(Set dependencies)

(JobDependency collection)

setDescription

void setDescription(String description)

The description of the job. Can be set only in a job template.

setDuration

void setDuration(Long duration)

The length of time in seconds requested for the job. Note that it is possible to set duration to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg. Valid during POST. Valid during PUT.

setDurationActive

void setDurationActive(Long durationActive)

The length of time in seconds the job has been active or running.

setDurationQueued

void setDurationQueued(Long durationQueued)

The length of time in seconds the job has been eligible to run in the queue.

setDurationRemaining

void setDurationRemaining(Long durationRemaining)

An estimate of the time remaining, in seconds, before the job will complete.

setDurationSuspended

void setDurationSuspended(Long durationSuspended)

The length of time in seconds the job has been suspended.

setEmailNotifyAddresses

void setEmailNotifyAddresses(Set emailNotifyAddresses)

(String collection) The list of addresses to whom email is sent by the execution server. Valid during POST.

See Also:

String

setEmailNotifyTypes

void setEmailNotifyTypes(Set emailNotifyTypes)

(JobEmailNotifyType collection) The list of email notify types attached to the job. Valid during POST.

See Also:

JobEmailNotifyType

setEnvironmentRequested

void setEnvironmentRequested(Boolean environmentRequested)

Setting this field to true tells the Moab Workload Manager to set various variables, if populated, in the job's environment. Valid during POST.

setEnvironmentVariables

void setEnvironmentVariables(Map environmentVariables)

(Map of String => String) The list of environment variables for this job. Valid during POST.

See Also:

Map

setEpilogScript

void setEpilogScript(String epilogScript)

The path to the TORQUE epilog script. Valid during POST.

setFlags

void setFlags(Set flags)

(JobFlag collection) The flags that are set on this job. Valid during POST. Valid during PUT.

See Also:

JobFlag

setHoldDate

void setHoldDate(Date holdDate)

The date the most recent hold was placed on the job.

setHoldReason

void setHoldReason(JobHoldReason holdReason)

The reason the job is on hold.

setHolds

void setHolds(Set holds)

(JobHoldType collection) The holds that are set on the job. The "User" hold type is valid during POST. Valid during PUT.

See Also:

JobHoldType

setId

void setId(String id)

The unique identifier of this job. Note: this field is not user-assigned and is generated by the database.

setInitialWorkingDirectory

void setInitialWorkingDirectory(String initialWorkingDirectory)

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

setIsActive

void setIsActive(Boolean isActive)

True if the job is active, false if the job is complete.

setJobGroup

void setJobGroup(String jobGroup)

The job group to which this job belongs (different from credentials.group). Valid during POST.

setMasterNode

void setMasterNode(DomainProxy masterNode)

The first node in the list of allocated nodes for this job. For TORQUE jobs, this represents the "mother superior."

setMemorySecondsDedicated

void setMemorySecondsDedicated(Double memorySecondsDedicated)

The memory seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.

setMemorySecondsUtilized

void setMemorySecondsUtilized(Double memorySecondsUtilized)

The memory seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.

setMessages

void setMessages(Set messages)

(Message collection) The list of messages associated with the job. The "message" field is valid during PUT.

See Also:

Message

setMigrateCount

void setMigrateCount(Integer migrateCount)

The number of times the job has been migrated.

setMinimumPreemptTime

void setMinimumPreemptTime(Long minimumPreemptTime)

The minimum length of time, in seconds, an active job must be running before it is eligible for preemption.

setMwmName

void setMwmName(String mwmName)

The name of the Moab Workload Manager instance that owns this job.

setName

void setName(String name)

The name of this job. This name is unique per instance of Moab Workload Manager (i.e. not globally).

setNodesExcluded

void setNodesExcluded(Set nodesExcluded)

(DomainProxy collection) The list of nodes that should not be considered for this job. Valid during POST.

See Also:

DomainProxy

setNodesRequested

void setNodesRequested(Set nodesRequested)

(DomainProxy collection) The exact set, superset, or subset of nodes on which this job must run. Valid during POST.

See Also:

nodesRequestedPolicy

DomainProxy

setNodesRequestedPolicy

void setNodesRequestedPolicy(JobHostListMode nodesRequestedPolicy)

Indicates an exact set, superset, or subset of nodes on which the job must run. Only relevant if nodesRequested is provided. Valid during POST.

See Also:

nodesRequested

setPartitionAccessList

void setPartitionAccessList(Set partitionAccessList)

(String collection) The list of partitions that this job can access.

See Also:

String

setPartitionAccessListRequested

void setPartitionAccessListRequested(Set partitionAccessListRequested)

(String collection) The list of partitions that this job has requested. Valid during POST. Valid during PUT.

See Also:

String

setPreemptCount

void setPreemptCount(Integer preemptCount)

The number of times the job has been preempted.

setPriorities

void setPriorities(JobPriority priorities)

The list of priorities for the job. The "user" field is valid during POST. The "user" field is valid during PUT.

setProcessorSecondsDedicated

void setProcessorSecondsDedicated(Double processorSecondsDedicated)

The processor seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.

setProcessorSecondsLimit

void setProcessorSecondsLimit(Double processorSecondsLimit)

The limit for processorSecondsUtilized.

setProcessorSecondsUtilized

void setProcessorSecondsUtilized(Double processorSecondsUtilized)

The processor seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.

setPrologScript

void setPrologScript(String prologScript)

The path to the TORQUE prolog script. Valid during POST.

setQueueStatus

void setQueueStatus(JobQueueStatus queueStatus)

The status of the job in its queue.

setRejectPolicies

void setRejectPolicies(Set rejectPolicies)

(JobRejectPolicy collection) The list of policies enabled when a job is rejected.

See Also:

JobRejectPolicy

setRequirements

void setRequirements(Set requirements)

(JobRequirement collection) The list of items required for this job to run. Some fields are valid during POST.

See Also:

JobRequirement

setReservationRequested

void setReservationRequested(DomainProxy reservationRequested)

The reservation that the job requested. Valid during POST. Valid during PUT.

setResourceFailPolicy

void setResourceFailPolicy(JobResourceFailPolicyType resourceFailPolicy)

The policy that dictates what should happen to the job if it is running and at least one of the resources it is using fails. Valid during POST.

setResourceManagerExtension

void setResourceManagerExtension(String resourceManagerExtension)

If provided during POST, this string will be added to the resource manager extension section of the job submission. Example: "bandwidth=120;queuejob=false"
Note that the delimiter between resourceManagerExtension elements is the semicolon. Valid during POST.

setResourceManagers

void setResourceManagers(Set resourceManagers)

(ResourceManager collection) The list of resource managers associated with this job.

See Also:

ResourceManager

setRmStandardErrorFilePath

void setRmStandardErrorFilePath(String rmStandardErrorFilePath)

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

setRmStandardOutputFilePath

void setRmStandardOutputFilePath(String rmStandardOutputFilePath)

The path to the remote file containing the standard output of the job.

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.

setStates

void setStates(JobStateInformation states)

Information about the state of the job.

setSubmitHost

void setSubmitHost(String submitHost)

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

setSystemJobAction

void setSystemJobAction(String systemJobAction)

The action the system job will take.

setSystemJobType

void setSystemJobType(JobSystemJobType systemJobType)

The type of system job. In the Moab Cloud Suite, this will usually be "vmtracking" or "generic."

setTargetedJobAction

void setTargetedJobAction(JobActionType targetedJobAction)

The action that this job is performing on another job.

setTargetedJobName

void setTargetedJobName(String targetedJobName)

The name of the job on which this job is performing the targetedJobAction.

setTemplates

void setTemplates(Set templates)

(DomainProxy collection) The list of all job templates to be set on this job. Valid during POST.

See Also:

DomainProxy

setTriggers

void setTriggers(Set triggers)

(String collection) The list of triggers associated with this job.

See Also:

String

setVariables

void setVariables(Map variables)

(Map of String => String) The list of variables that this job owns or sets on completion. Valid during POST. Valid during PUT.

See Also:

Map

setVirtualContainers

void setVirtualContainers(Set virtualContainers)

(DomainProxy collection) When submitting this job, add it to the specified existing virtual container. Valid during POST, but only one virtual container can be specified.

See Also:

DomainProxy

setVirtualMachines

void setVirtualMachines(Set virtualMachines)

(DomainProxy collection) The list of virtual machines that are allocated to this job.

See Also:

DomainProxy

setVmUsagePolicy

void setVmUsagePolicy(VMUsagePolicy vmUsagePolicy)

The requested Virtual Machine Usage Policy for this job. Valid during POST.

toString

String toString()

Groovy Documentation