Groovy Documentation

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

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

class JobRequirement

Field Summary
private String architecture

The architecture required by the job.

private Set attributes

(JobRequirementAttribute collection) Required node attributes, with version number support.

private Set features

(String collection) The list of node features the job is scheduled against.

private Set featuresExcluded

(String collection) Excluded node features.

private JobRequirementFeaturesMode featuresExcludedMode

Indicates whether excluded features should be AND'ed or OR'd.

private Set featuresRequested

(String collection) Requested node features.

private JobRequirementFeaturesMode featuresRequestedMode

Indicates whether requested features should be AND'ed or OR'd.

private String image

The image required by the job.

private Integer index

The index of the requirement, starting with 0.

private Map metrics

(Map of String => Double) Generic metrics associated with the job as reported by the resource manager.

private NodeAccessPolicy nodeAccessPolicy

Specifies how node resources should be accessed.

private NodeAllocationPolicy nodeAllocationPolicy

Specifies how node resources should be selected and allocated to the job.

private Integer nodeCount

The number of nodes required by the job.

private String nodeSet

The requested nodeset of the job.

private Set nodes

(AllocatedNode collection) Nodes that have been allocated to meet this requirement.

private DomainProxy reservation

The allocated reservation (assigned after the job has a reservation).

private Map resourcesPerTask

(Map of String => JobResource) Contains requirements for disk, memory, processors, swap, and generic resources.

private Integer taskCount

The number of tasks (processors) required by this job.

private Integer tasksPerNode

The number of tasks to map to each node.

 
Constructor Summary
JobRequirement()

 
Method Summary
String getArchitecture()

The architecture required by the job.

Set getAttributes()

(JobRequirementAttribute collection) Required node attributes, with version number support.

Set getFeatures()

(String collection) The list of node features the job is scheduled against.

Set getFeaturesExcluded()

(String collection) Excluded node features.

JobRequirementFeaturesMode getFeaturesExcludedMode()

Indicates whether excluded features should be AND'ed or OR'd.

Set getFeaturesRequested()

(String collection) Requested node features.

JobRequirementFeaturesMode getFeaturesRequestedMode()

Indicates whether requested features should be AND'ed or OR'd.

String getImage()

The image required by the job.

Integer getIndex()

The index of the requirement, starting with 0.

Map getMetrics()

(Map of String => Double) Generic metrics associated with the job as reported by the resource manager.

NodeAccessPolicy getNodeAccessPolicy()

Specifies how node resources should be accessed.

NodeAllocationPolicy getNodeAllocationPolicy()

Specifies how node resources should be selected and allocated to the job.

Integer getNodeCount()

The number of nodes required by the job.

String getNodeSet()

The requested nodeset of the job.

Set getNodes()

(AllocatedNode collection) Nodes that have been allocated to meet this requirement.

DomainProxy getReservation()

The allocated reservation (assigned after the job has a reservation).

Map getResourcesPerTask()

(Map of String => JobResource) Contains requirements for disk, memory, processors, swap, and generic resources.

Integer getTaskCount()

The number of tasks (processors) required by this job.

Integer getTasksPerNode()

The number of tasks to map to each node.

void setArchitecture(String architecture)

The architecture required by the job.

void setAttributes(Set attributes)

(JobRequirementAttribute collection) Required node attributes, with version number support.

void setFeatures(Set features)

(String collection) The list of node features the job is scheduled against.

void setFeaturesExcluded(Set featuresExcluded)

(String collection) Excluded node features.

void setFeaturesExcludedMode(JobRequirementFeaturesMode featuresExcludedMode)

Indicates whether excluded features should be AND'ed or OR'd.

void setFeaturesRequested(Set featuresRequested)

(String collection) Requested node features.

void setFeaturesRequestedMode(JobRequirementFeaturesMode featuresRequestedMode)

Indicates whether requested features should be AND'ed or OR'd.

void setImage(String image)

The image required by the job.

void setIndex(Integer index)

The index of the requirement, starting with 0.

void setMetrics(Map metrics)

(Map of String => Double) Generic metrics associated with the job as reported by the resource manager.

void setNodeAccessPolicy(NodeAccessPolicy nodeAccessPolicy)

Specifies how node resources should be accessed.

void setNodeAllocationPolicy(NodeAllocationPolicy nodeAllocationPolicy)

Specifies how node resources should be selected and allocated to the job.

void setNodeCount(Integer nodeCount)

The number of nodes required by the job.

void setNodeSet(String nodeSet)

The requested nodeset of the job.

void setNodes(Set nodes)

(AllocatedNode collection) Nodes that have been allocated to meet this requirement.

void setReservation(DomainProxy reservation)

The allocated reservation (assigned after the job has a reservation).

void setResourcesPerTask(Map resourcesPerTask)

(Map of String => JobResource) Contains requirements for disk, memory, processors, swap, and generic resources.

void setTaskCount(Integer taskCount)

The number of tasks (processors) required by this job.

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

architecture

private String architecture
The architecture required by the job. Valid during POST.


attributes

private Set attributes
(JobRequirementAttribute collection) Required node attributes, with version number support. Note: If the job requirements array has more than one element that contains attributes, only the first occurrence will be used. Valid during POST.
See Also:
JobRequirementAttribute


features

private Set features
(String collection) The list of node features the job is scheduled against.
See Also:
String


featuresExcluded

private Set featuresExcluded
(String collection) Excluded node features. That is, do not select nodes with these features. Valid during POST.
See Also:
featuresExcludedMode
String


featuresExcludedMode

private JobRequirementFeaturesMode featuresExcludedMode
Indicates whether excluded features should be AND'ed or OR'd. The default is AND. Only relevant if featuresExcluded is provided. Valid during POST.
See Also:
featuresExcluded


featuresRequested

private Set featuresRequested
(String collection) Requested node features. Valid during POST.
See Also:
featuresRequestedMode
String


featuresRequestedMode

private JobRequirementFeaturesMode featuresRequestedMode
Indicates whether requested features should be AND'ed or OR'd. The default is AND. Only relevant if featuresRequested is provided. Valid during POST.
See Also:
featuresRequested


image

private String image
The image required by the job. Valid during POST.


index

private Integer index
The index of the requirement, starting with 0.


metrics

private Map metrics
(Map of String => Double) Generic metrics associated with the job as reported by the resource manager.
See Also:
Double


nodeAccessPolicy

private NodeAccessPolicy nodeAccessPolicy
Specifies how node resources should be accessed. Note: If the job requirements array has more than one element that contains nodeAccessPolicy, only the first occurrence will be used. Valid during POST.


nodeAllocationPolicy

private NodeAllocationPolicy nodeAllocationPolicy
Specifies how node resources should be selected and allocated to the job. Note: If the job requirements array has more than one element that contains nodeAllocationPolicy, only the first occurrence will be used. Valid during POST.


nodeCount

private Integer nodeCount
The number of nodes required by the job. Valid during POST.


nodeSet

private String nodeSet
The requested nodeset of the job.


nodes

private Set nodes
(AllocatedNode collection) Nodes that have been allocated to meet this requirement.
See Also:
AllocatedNode


reservation

private DomainProxy reservation
The allocated reservation (assigned after the job has a reservation).


resourcesPerTask

private Map resourcesPerTask
(Map of String => JobResource) Contains requirements for disk, memory, processors, swap, and generic resources. For disk, memory, and swap, the unit is MB. For each resource, the "dedicated" field can be set during POST.
See Also:
JobResource


taskCount

private Integer taskCount
The number of tasks (processors) required by this job. 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

getArchitecture

String getArchitecture()
The architecture required by the job. Valid during POST.


getAttributes

Set getAttributes()
(JobRequirementAttribute collection) Required node attributes, with version number support. Note: If the job requirements array has more than one element that contains attributes, only the first occurrence will be used. Valid during POST.
See Also:
JobRequirementAttribute


getFeatures

Set getFeatures()
(String collection) The list of node features the job is scheduled against.
See Also:
String


getFeaturesExcluded

Set getFeaturesExcluded()
(String collection) Excluded node features. That is, do not select nodes with these features. Valid during POST.
See Also:
featuresExcludedMode
String


getFeaturesExcludedMode

JobRequirementFeaturesMode getFeaturesExcludedMode()
Indicates whether excluded features should be AND'ed or OR'd. The default is AND. Only relevant if featuresExcluded is provided. Valid during POST.
See Also:
featuresExcluded


getFeaturesRequested

Set getFeaturesRequested()
(String collection) Requested node features. Valid during POST.
See Also:
featuresRequestedMode
String


getFeaturesRequestedMode

JobRequirementFeaturesMode getFeaturesRequestedMode()
Indicates whether requested features should be AND'ed or OR'd. The default is AND. Only relevant if featuresRequested is provided. Valid during POST.
See Also:
featuresRequested


getImage

String getImage()
The image required by the job. Valid during POST.


getIndex

Integer getIndex()
The index of the requirement, starting with 0.


getMetrics

Map getMetrics()
(Map of String => Double) Generic metrics associated with the job as reported by the resource manager.
See Also:
Double


getNodeAccessPolicy

NodeAccessPolicy getNodeAccessPolicy()
Specifies how node resources should be accessed. Note: If the job requirements array has more than one element that contains nodeAccessPolicy, only the first occurrence will be used. Valid during POST.


getNodeAllocationPolicy

NodeAllocationPolicy getNodeAllocationPolicy()
Specifies how node resources should be selected and allocated to the job. Note: If the job requirements array has more than one element that contains nodeAllocationPolicy, only the first occurrence will be used. Valid during POST.


getNodeCount

Integer getNodeCount()
The number of nodes required by the job. Valid during POST.


getNodeSet

String getNodeSet()
The requested nodeset of the job.


getNodes

Set getNodes()
(AllocatedNode collection) Nodes that have been allocated to meet this requirement.
See Also:
AllocatedNode


getReservation

DomainProxy getReservation()
The allocated reservation (assigned after the job has a reservation).


getResourcesPerTask

Map getResourcesPerTask()
(Map of String => JobResource) Contains requirements for disk, memory, processors, swap, and generic resources. For disk, memory, and swap, the unit is MB. For each resource, the "dedicated" field can be set during POST.
See Also:
JobResource


getTaskCount

Integer getTaskCount()
The number of tasks (processors) required by this job. Valid during POST.


getTasksPerNode

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


setArchitecture

void setArchitecture(String architecture)
The architecture required by the job. Valid during POST.


setAttributes

void setAttributes(Set attributes)
(JobRequirementAttribute collection) Required node attributes, with version number support. Note: If the job requirements array has more than one element that contains attributes, only the first occurrence will be used. Valid during POST.
See Also:
JobRequirementAttribute


setFeatures

void setFeatures(Set features)
(String collection) The list of node features the job is scheduled against.
See Also:
String


setFeaturesExcluded

void setFeaturesExcluded(Set featuresExcluded)
(String collection) Excluded node features. That is, do not select nodes with these features. Valid during POST.
See Also:
featuresExcludedMode
String


setFeaturesExcludedMode

void setFeaturesExcludedMode(JobRequirementFeaturesMode featuresExcludedMode)
Indicates whether excluded features should be AND'ed or OR'd. The default is AND. Only relevant if featuresExcluded is provided. Valid during POST.
See Also:
featuresExcluded


setFeaturesRequested

void setFeaturesRequested(Set featuresRequested)
(String collection) Requested node features. Valid during POST.
See Also:
featuresRequestedMode
String


setFeaturesRequestedMode

void setFeaturesRequestedMode(JobRequirementFeaturesMode featuresRequestedMode)
Indicates whether requested features should be AND'ed or OR'd. The default is AND. Only relevant if featuresRequested is provided. Valid during POST.
See Also:
featuresRequested


setImage

void setImage(String image)
The image required by the job. Valid during POST.


setIndex

void setIndex(Integer index)
The index of the requirement, starting with 0.


setMetrics

void setMetrics(Map metrics)
(Map of String => Double) Generic metrics associated with the job as reported by the resource manager.
See Also:
Double


setNodeAccessPolicy

void setNodeAccessPolicy(NodeAccessPolicy nodeAccessPolicy)
Specifies how node resources should be accessed. Note: If the job requirements array has more than one element that contains nodeAccessPolicy, only the first occurrence will be used. Valid during POST.


setNodeAllocationPolicy

void setNodeAllocationPolicy(NodeAllocationPolicy nodeAllocationPolicy)
Specifies how node resources should be selected and allocated to the job. Note: If the job requirements array has more than one element that contains nodeAllocationPolicy, only the first occurrence will be used. Valid during POST.


setNodeCount

void setNodeCount(Integer nodeCount)
The number of nodes required by the job. Valid during POST.


setNodeSet

void setNodeSet(String nodeSet)
The requested nodeset of the job.


setNodes

void setNodes(Set nodes)
(AllocatedNode collection) Nodes that have been allocated to meet this requirement.
See Also:
AllocatedNode


setReservation

void setReservation(DomainProxy reservation)
The allocated reservation (assigned after the job has a reservation).


setResourcesPerTask

void setResourcesPerTask(Map resourcesPerTask)
(Map of String => JobResource) Contains requirements for disk, memory, processors, swap, and generic resources. For disk, memory, and swap, the unit is MB. For each resource, the "dedicated" field can be set during POST.
See Also:
JobResource


setTaskCount

void setTaskCount(Integer taskCount)
The number of tasks (processors) required by this job. 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