Groovy Documentation

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

java.lang.Object
  com.ace.mws.jobs.JobRequirement

class JobRequirement

This class defines all the requirements a job needs in order to run. Multiple job requirement objects can be used to when determining if resources are sufficient to use for running a job.


Field Summary
private Set allocatedNodes

(Node collection) The set of nodes to which the requirement is allocated.

private String allocatedPartition

The partition allocated to the requirement.

private Map genericResources

(Map of String => Integer) The set of generic resources for this job.

private NodeAccessPolicy nodeAccessPolicy

The node access policy the requirement asks for.

private Set preferredNodeFeatures

(String collection) The list of preferred node features.

private String requiredArchitecture

The required architecture.

private String requiredClass

The required class/queue.

private Integer requiredDiskPerTask

Required disk per task, in MB.

private Integer requiredMemoryPerTask

Required memory per task, in MB.

private String requiredNetwork

The required network.

private Integer requiredNodeCountMinimum

The minimum number of nodes called for by the requirement.

private Integer requiredNodeDisk

The required disk space in MB across all nodes.

private Set requiredNodeFeatures

(String collection) The list of required node features.

private Integer requiredNodeMemory

The required memory in MB across all nodes.

private Integer requiredNodeProcessors

The required processors needed on a per node basis.

private Integer requiredNodeSwap

The required swap in MB across all nodes.

private String requiredPartition

A colon-separated list that specifies the partition (or partitions) in which the job must run.

private Integer requiredProcessorCountMinimum

The minimum task count for this requirement.

private Integer requiredProcessorsPerTask

Required processors per task.

private Integer requiredSwapPerTask

Required swap per task, in MB.

private Integer tasksPerNode

The number of tasks to map to each node.

 
Constructor Summary
JobRequirement()

 
Method Summary
Set getAllocatedNodes()

(Node collection) The set of nodes to which the requirement is allocated.

String getAllocatedPartition()

The partition allocated to the requirement.

Map getGenericResources()

(Map of String => Integer) The set of generic resources for this job.

NodeAccessPolicy getNodeAccessPolicy()

The node access policy the requirement asks for.

Set getPreferredNodeFeatures()

(String collection) The list of preferred node features.

String getRequiredArchitecture()

The required architecture.

String getRequiredClass()

The required class/queue.

Integer getRequiredDiskPerTask()

Required disk per task, in MB.

Integer getRequiredMemoryPerTask()

Required memory per task, in MB.

String getRequiredNetwork()

The required network.

Integer getRequiredNodeCountMinimum()

The minimum number of nodes called for by the requirement.

Integer getRequiredNodeDisk()

The required disk space in MB across all nodes.

Set getRequiredNodeFeatures()

(String collection) The list of required node features.

Integer getRequiredNodeMemory()

The required memory in MB across all nodes.

Integer getRequiredNodeProcessors()

The required processors needed on a per node basis.

Integer getRequiredNodeSwap()

The required swap in MB across all nodes.

String getRequiredPartition()

A colon-separated list that specifies the partition (or partitions) in which the job must run.

Integer getRequiredProcessorCountMinimum()

The minimum task count for this requirement.

Integer getRequiredProcessorsPerTask()

Required processors per task.

Integer getRequiredSwapPerTask()

Required swap per task, in MB.

Integer getTasksPerNode()

The number of tasks to map to each node.

void setAllocatedNodes(Set allocatedNodes)

(Node collection) The set of nodes to which the requirement is allocated.

void setAllocatedPartition(String allocatedPartition)

The partition allocated to the requirement.

void setGenericResources(Map genericResources)

(Map of String => Integer) The set of generic resources for this job.

void setNodeAccessPolicy(NodeAccessPolicy nodeAccessPolicy)

The node access policy the requirement asks for.

void setPreferredNodeFeatures(Set preferredNodeFeatures)

(String collection) The list of preferred node features.

void setRequiredArchitecture(String requiredArchitecture)

The required architecture.

void setRequiredClass(String requiredClass)

The required class/queue.

void setRequiredDiskPerTask(Integer requiredDiskPerTask)

Required disk per task, in MB.

void setRequiredMemoryPerTask(Integer requiredMemoryPerTask)

Required memory per task, in MB.

void setRequiredNetwork(String requiredNetwork)

The required network.

void setRequiredNodeCountMinimum(Integer requiredNodeCountMinimum)

The minimum number of nodes called for by the requirement.

void setRequiredNodeDisk(Integer requiredNodeDisk)

The required disk space in MB across all nodes.

void setRequiredNodeFeatures(Set requiredNodeFeatures)

(String collection) The list of required node features.

void setRequiredNodeMemory(Integer requiredNodeMemory)

The required memory in MB across all nodes.

void setRequiredNodeProcessors(Integer requiredNodeProcessors)

The required processors needed on a per node basis.

void setRequiredNodeSwap(Integer requiredNodeSwap)

The required swap in MB across all nodes.

void setRequiredPartition(String requiredPartition)

A colon-separated list that specifies the partition (or partitions) in which the job must run.

void setRequiredProcessorCountMinimum(Integer requiredProcessorCountMinimum)

The minimum task count for this requirement.

void setRequiredProcessorsPerTask(Integer requiredProcessorsPerTask)

Required processors per task.

void setRequiredSwapPerTask(Integer requiredSwapPerTask)

Required swap per task, in MB.

void setTasksPerNode(Integer tasksPerNode)

The number of tasks to map to each node.

String toString()

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

Field Detail

allocatedNodes

private Set allocatedNodes
(Node collection) The set of nodes to which the requirement is allocated.
See Also:
Node


allocatedPartition

private String allocatedPartition
The partition allocated to the requirement.


genericResources

private Map genericResources
(Map of String => Integer) The set of generic resources for this job. Each generic resource has a name and an associated amount. Valid during POST.
See Also:
Integer


nodeAccessPolicy

private NodeAccessPolicy nodeAccessPolicy
The node access policy the requirement asks for. Valid during POST.


preferredNodeFeatures

private Set preferredNodeFeatures
(String collection) The list of preferred node features.
See Also:
String


requiredArchitecture

private String requiredArchitecture
The required architecture. Valid during POST.


requiredClass

private String requiredClass
The required class/queue.


requiredDiskPerTask

private Integer requiredDiskPerTask
Required disk per task, in MB. Valid during POST.


requiredMemoryPerTask

private Integer requiredMemoryPerTask
Required memory per task, in MB. Valid during POST.


requiredNetwork

private String requiredNetwork
The required network.


requiredNodeCountMinimum

private Integer requiredNodeCountMinimum
The minimum number of nodes called for by the requirement.


requiredNodeDisk

private Integer requiredNodeDisk
The required disk space in MB across all nodes.


requiredNodeFeatures

private Set requiredNodeFeatures
(String collection) The list of required node features. Valid during POST.
See Also:
String


requiredNodeMemory

private Integer requiredNodeMemory
The required memory in MB across all nodes.


requiredNodeProcessors

private Integer requiredNodeProcessors
The required processors needed on a per node basis.


requiredNodeSwap

private Integer requiredNodeSwap
The required swap in MB across all nodes.


requiredPartition

private String requiredPartition
A colon-separated list that specifies the partition (or partitions) in which the job must run. Valid during PUT. Valid during POST.


requiredProcessorCountMinimum

private Integer requiredProcessorCountMinimum
The minimum task count for this requirement. Valid during POST.


requiredProcessorsPerTask

private Integer requiredProcessorsPerTask
Required processors per task. Valid during POST.


requiredSwapPerTask

private Integer requiredSwapPerTask
Required swap per task, in MB. Valid during POST.


tasksPerNode

private Integer tasksPerNode
The number of tasks to map to each node. Valid during POST.


 
Constructor Detail

JobRequirement

JobRequirement()


 
Method Detail

getAllocatedNodes

Set getAllocatedNodes()
(Node collection) The set of nodes to which the requirement is allocated.
See Also:
Node


getAllocatedPartition

String getAllocatedPartition()
The partition allocated to the requirement.


getGenericResources

Map getGenericResources()
(Map of String => Integer) The set of generic resources for this job. Each generic resource has a name and an associated amount. Valid during POST.
See Also:
Integer


getNodeAccessPolicy

NodeAccessPolicy getNodeAccessPolicy()
The node access policy the requirement asks for. Valid during POST.


getPreferredNodeFeatures

Set getPreferredNodeFeatures()
(String collection) The list of preferred node features.
See Also:
String


getRequiredArchitecture

String getRequiredArchitecture()
The required architecture. Valid during POST.


getRequiredClass

String getRequiredClass()
The required class/queue.


getRequiredDiskPerTask

Integer getRequiredDiskPerTask()
Required disk per task, in MB. Valid during POST.


getRequiredMemoryPerTask

Integer getRequiredMemoryPerTask()
Required memory per task, in MB. Valid during POST.


getRequiredNetwork

String getRequiredNetwork()
The required network.


getRequiredNodeCountMinimum

Integer getRequiredNodeCountMinimum()
The minimum number of nodes called for by the requirement.


getRequiredNodeDisk

Integer getRequiredNodeDisk()
The required disk space in MB across all nodes.


getRequiredNodeFeatures

Set getRequiredNodeFeatures()
(String collection) The list of required node features. Valid during POST.
See Also:
String


getRequiredNodeMemory

Integer getRequiredNodeMemory()
The required memory in MB across all nodes.


getRequiredNodeProcessors

Integer getRequiredNodeProcessors()
The required processors needed on a per node basis.


getRequiredNodeSwap

Integer getRequiredNodeSwap()
The required swap in MB across all nodes.


getRequiredPartition

String getRequiredPartition()
A colon-separated list that specifies the partition (or partitions) in which the job must run. Valid during PUT. Valid during POST.


getRequiredProcessorCountMinimum

Integer getRequiredProcessorCountMinimum()
The minimum task count for this requirement. Valid during POST.


getRequiredProcessorsPerTask

Integer getRequiredProcessorsPerTask()
Required processors per task. Valid during POST.


getRequiredSwapPerTask

Integer getRequiredSwapPerTask()
Required swap per task, in MB. Valid during POST.


getTasksPerNode

Integer getTasksPerNode()
The number of tasks to map to each node. Valid during POST.


setAllocatedNodes

void setAllocatedNodes(Set allocatedNodes)
(Node collection) The set of nodes to which the requirement is allocated.
See Also:
Node


setAllocatedPartition

void setAllocatedPartition(String allocatedPartition)
The partition allocated to the requirement.


setGenericResources

void setGenericResources(Map genericResources)
(Map of String => Integer) The set of generic resources for this job. Each generic resource has a name and an associated amount. Valid during POST.
See Also:
Integer


setNodeAccessPolicy

void setNodeAccessPolicy(NodeAccessPolicy nodeAccessPolicy)
The node access policy the requirement asks for. Valid during POST.


setPreferredNodeFeatures

void setPreferredNodeFeatures(Set preferredNodeFeatures)
(String collection) The list of preferred node features.
See Also:
String


setRequiredArchitecture

void setRequiredArchitecture(String requiredArchitecture)
The required architecture. Valid during POST.


setRequiredClass

void setRequiredClass(String requiredClass)
The required class/queue.


setRequiredDiskPerTask

void setRequiredDiskPerTask(Integer requiredDiskPerTask)
Required disk per task, in MB. Valid during POST.


setRequiredMemoryPerTask

void setRequiredMemoryPerTask(Integer requiredMemoryPerTask)
Required memory per task, in MB. Valid during POST.


setRequiredNetwork

void setRequiredNetwork(String requiredNetwork)
The required network.


setRequiredNodeCountMinimum

void setRequiredNodeCountMinimum(Integer requiredNodeCountMinimum)
The minimum number of nodes called for by the requirement.


setRequiredNodeDisk

void setRequiredNodeDisk(Integer requiredNodeDisk)
The required disk space in MB across all nodes.


setRequiredNodeFeatures

void setRequiredNodeFeatures(Set requiredNodeFeatures)
(String collection) The list of required node features. Valid during POST.
See Also:
String


setRequiredNodeMemory

void setRequiredNodeMemory(Integer requiredNodeMemory)
The required memory in MB across all nodes.


setRequiredNodeProcessors

void setRequiredNodeProcessors(Integer requiredNodeProcessors)
The required processors needed on a per node basis.


setRequiredNodeSwap

void setRequiredNodeSwap(Integer requiredNodeSwap)
The required swap in MB across all nodes.


setRequiredPartition

void setRequiredPartition(String requiredPartition)
A colon-separated list that specifies the partition (or partitions) in which the job must run. Valid during PUT. Valid during POST.


setRequiredProcessorCountMinimum

void setRequiredProcessorCountMinimum(Integer requiredProcessorCountMinimum)
The minimum task count for this requirement. Valid during POST.


setRequiredProcessorsPerTask

void setRequiredProcessorsPerTask(Integer requiredProcessorsPerTask)
Required processors per task. Valid during POST.


setRequiredSwapPerTask

void setRequiredSwapPerTask(Integer requiredSwapPerTask)
Required swap per task, in MB. Valid during POST.


setTasksPerNode

void setTasksPerNode(Integer tasksPerNode)
The number of tasks to map to each node. Valid during POST.


toString

String toString()


 

Groovy Documentation