Groovy Documentation

com.ace.mws.nodes
[Groovy] Class Node

java.lang.Object
  com.ace.mws.nodes.Node

class Node

This class represents a node in the Moab Workload Manager. Moab recognizes a node as a collection of resources with a particular set of associated attributes. This definition is similar to the traditional notion of a node found in a Linux cluster or supercomputer wherein a node is defined as one or more CPUs, associated memory, and possibly other compute resources such as local disk, swap, network adapters, and software licenses. Additionally, this node is described by various attributes such as an architecture type or operating system. Nodes range in size from small uniprocessor PCs to large symmetric multiprocessing (SMP) systems where a single node may consist of hundreds of CPUs and massive amounts of memory.


Field Summary
private String architecture

This node's processor architecture.

private Set classes

(String collection) The classes that this node can be scheduled for.

private Set featuresReported

(String collection) The features this node advertises.

private String id

The unique identifier of this node.

private Integer index

The index for this node as reported by the resource manager.

private String ipAddress

This node's IPv4 address.

private Boolean isHypervisor

True if the node is a hypervisor, false otherwise.

private Set jobs

(DomainProxy collection) Jobs associated with this node.

private Date lastUpdatedDate

The timestamp of the last moment when this node was updated.

private Set messages

(Message collection) The list of messages attached to this node.

private Map metrics

(Map of String => Double) Metrics are the measurable, quantitative, and changing aspects of this node.

private Boolean migrationDisabled

True if VM migration is disabled on this node.

private String name

The name of this node.

private NodeOperatingSystemInformation operatingSystem

Describes the current or expected operating system image information for this node.

private String partition

The partition this node belongs to.

private Integer processorSpeed

The speed, in MHz, or the processors on this node.

private Boolean profilingEnabled

Indicates whether historical data gathering and reporting is enabled for this node.

private Integer rack

The rack where this node is located in the datacenter/cluster.

private Set reservations

(DomainProxy collection) Reservations associated with this node.

private Map resourceManagerMessages

(Map of String => String) The resource manager messages for this node.

private Set resourceManagers

(NodeResourceManager collection) The resource managers that are reporting or have previously reported this node.

private Map resources

(Map of String => Resource) Contains references of a string representing a resource name to a resource object detailing the amount of the resource that is available, configured, etc.

private Integer slot

The slot in the rack where this node is located.

private NodeStateInformation states

This node's state.

private Set triggers

(DomainProxy collection) Triggers associated with this node.

private NodeType type

The type of this node is governed by the types of resources it offers.

private Map variables

(Map of String => String) Variables is a map of key-value pairs, synonymous, but not directly related to, environment variables.

private Set virtualContainers

(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this node.

private Set virtualMachines

(DomainProxy collection) Virtual machines associated with this node.

 
Constructor Summary
Node()

 
Method Summary
String getArchitecture()

This node's processor architecture.

Set getClasses()

(String collection) The classes that this node can be scheduled for.

Set getFeaturesReported()

(String collection) The features this node advertises.

String getId()

The unique identifier of this node.

Integer getIndex()

The index for this node as reported by the resource manager.

String getIpAddress()

This node's IPv4 address.

Boolean getIsHypervisor()

True if the node is a hypervisor, false otherwise.

Set getJobs()

(DomainProxy collection) Jobs associated with this node.

Date getLastUpdatedDate()

The timestamp of the last moment when this node was updated.

Set getMessages()

(Message collection) The list of messages attached to this node.

Map getMetrics()

(Map of String => Double) Metrics are the measurable, quantitative, and changing aspects of this node.

Boolean getMigrationDisabled()

True if VM migration is disabled on this node.

String getName()

The name of this node.

NodeOperatingSystemInformation getOperatingSystem()

Describes the current or expected operating system image information for this node.

String getPartition()

The partition this node belongs to.

Integer getProcessorSpeed()

The speed, in MHz, or the processors on this node.

Boolean getProfilingEnabled()

Indicates whether historical data gathering and reporting is enabled for this node.

Integer getRack()

The rack where this node is located in the datacenter/cluster.

Set getReservations()

(DomainProxy collection) Reservations associated with this node.

Map getResourceManagerMessages()

(Map of String => String) The resource manager messages for this node.

Set getResourceManagers()

(NodeResourceManager collection) The resource managers that are reporting or have previously reported this node.

Map getResources()

(Map of String => Resource) Contains references of a string representing a resource name to a resource object detailing the amount of the resource that is available, configured, etc.

Integer getSlot()

The slot in the rack where this node is located.

NodeStateInformation getStates()

This node's state.

Set getTriggers()

(DomainProxy collection) Triggers associated with this node.

NodeType getType()

The type of this node is governed by the types of resources it offers.

Map getVariables()

(Map of String => String) Variables is a map of key-value pairs, synonymous, but not directly related to, environment variables.

Set getVirtualContainers()

(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this node.

Set getVirtualMachines()

(DomainProxy collection) Virtual machines associated with this node.

void setArchitecture(String architecture)

This node's processor architecture.

void setClasses(Set classes)

(String collection) The classes that this node can be scheduled for.

void setFeaturesReported(Set featuresReported)

(String collection) The features this node advertises.

void setId(String id)

The unique identifier of this node.

void setIndex(Integer index)

The index for this node as reported by the resource manager.

void setIpAddress(String ipAddress)

This node's IPv4 address.

void setIsHypervisor(Boolean isHypervisor)

True if the node is a hypervisor, false otherwise.

void setJobs(Set jobs)

(DomainProxy collection) Jobs associated with this node.

void setLastUpdatedDate(Date lastUpdatedDate)

The timestamp of the last moment when this node was updated.

void setMessages(Set messages)

(Message collection) The list of messages attached to this node.

void setMetrics(Map metrics)

(Map of String => Double) Metrics are the measurable, quantitative, and changing aspects of this node.

void setMigrationDisabled(Boolean migrationDisabled)

True if VM migration is disabled on this node.

void setName(String name)

The name of this node.

void setOperatingSystem(NodeOperatingSystemInformation operatingSystem)

Describes the current or expected operating system image information for this node.

void setPartition(String partition)

The partition this node belongs to.

void setProcessorSpeed(Integer processorSpeed)

The speed, in MHz, or the processors on this node.

void setProfilingEnabled(Boolean profilingEnabled)

Indicates whether historical data gathering and reporting is enabled for this node.

void setRack(Integer rack)

The rack where this node is located in the datacenter/cluster.

void setReservations(Set reservations)

(DomainProxy collection) Reservations associated with this node.

void setResourceManagerMessages(Map resourceManagerMessages)

(Map of String => String) The resource manager messages for this node.

void setResourceManagers(Set resourceManagers)

(NodeResourceManager collection) The resource managers that are reporting or have previously reported this node.

void setResources(Map resources)

(Map of String => Resource) Contains references of a string representing a resource name to a resource object detailing the amount of the resource that is available, configured, etc.

void setSlot(Integer slot)

The slot in the rack where this node is located.

void setStates(NodeStateInformation states)

This node's state.

void setTriggers(Set triggers)

(DomainProxy collection) Triggers associated with this node.

void setType(NodeType type)

The type of this node is governed by the types of resources it offers.

void setVariables(Map variables)

(Map of String => String) Variables is a map of key-value pairs, synonymous, but not directly related to, environment variables.

void setVirtualContainers(Set virtualContainers)

(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this node.

void setVirtualMachines(Set virtualMachines)

(DomainProxy collection) Virtual machines associated with this node.

String toString()

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

Field Detail

architecture

private String architecture
This node's processor architecture.


classes

private Set classes
(String collection) The classes that this node can be scheduled for.
See Also:
String


featuresReported

private Set featuresReported
(String collection) The features this node advertises. This can be used to define node sets.
See Also:
String


id

private String id
The unique identifier of this node. Note: this field is not user-assigned and is generated by the database.


index

private Integer index
The index for this node as reported by the resource manager.


ipAddress

private String ipAddress
This node's IPv4 address.


isHypervisor

private Boolean isHypervisor
True if the node is a hypervisor, false otherwise. This is based on the NodeOperatingSystemInformation#hypervisorType#hypervisorType field. If hypervisorType is present, the node is a hypervisor. If it is null, then it is not a hypervisor.


jobs

private Set jobs
(DomainProxy collection) Jobs associated with this node.
See Also:
DomainProxy


lastUpdatedDate

private Date lastUpdatedDate
The timestamp of the last moment when this node was updated. There is no guarantee that all user modifications to a node would be picked up. This will also be changed every RMPOLLINTERVAL even if a resource manager does not report information on this node.


messages

private Set messages
(Message collection) The list of messages attached to this node. They can be attached by admins, the resource manager layer, or triggers. Valid during PUT.
See Also:
Message


metrics

private Map metrics
(Map of String => Double) Metrics are the measurable, quantitative, and changing aspects of this node. They are used to define workload placement, attach triggers, etc. There are some built-in metrics: Valid during PUT.
See Also:
Double


migrationDisabled

private Boolean migrationDisabled
True if VM migration is disabled on this node.


name

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


operatingSystem

private NodeOperatingSystemInformation operatingSystem
Describes the current or expected operating system image information for this node.


partition

private String partition
The partition this node belongs to. Valid during PUT.


processorSpeed

private Integer processorSpeed
The speed, in MHz, or the processors on this node.


profilingEnabled

private Boolean profilingEnabled
Indicates whether historical data gathering and reporting is enabled for this node. This is also controlled by the same setting on the default node (i.e. all nodes). If set to false (default), node statistics are not gathered.


rack

private Integer rack
The rack where this node is located in the datacenter/cluster.


reservations

private Set reservations
(DomainProxy collection) Reservations associated with this node.
See Also:
DomainProxy


resourceManagerMessages

private Map resourceManagerMessages
(Map of String => String) The resource manager messages for this node. Each key is the name of a resource manager, and the value is the message that the resource manager has posted onto the node.
See Also:
Map


resourceManagers

private Set resourceManagers
(NodeResourceManager collection) The resource managers that are reporting or have previously reported this node. Each object also contains information on the resource manager reports.
See Also:
NodeResourceManager


resources

private Map resources
(Map of String => Resource) Contains references of a string representing a resource name to a resource object detailing the amount of the resource that is available, configured, etc.
Each key is the name of the resource, which equates to the generic resource identifier or one of "processors", "memory", "disk", or "swap". This name may be used as an id in the resource types web service.
See Also:
Resource


slot

private Integer slot
The slot in the rack where this node is located.


states

private NodeStateInformation states
This node's state. Valid during PUT.


triggers

private Set triggers
(DomainProxy collection) Triggers associated with this node.
See Also:
DomainProxy


type

private NodeType type
The type of this node is governed by the types of resources it offers.


variables

private Map variables
(Map of String => String) Variables is a map of key-value pairs, synonymous, but not directly related to, environment variables. They provide the mechanism to store arbitrary metdata which is useful to external systems in memory on this node. Valid during PUT.
See Also:
Map


virtualContainers

private Set virtualContainers
(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this node.
See Also:
DomainProxy


virtualMachines

private Set virtualMachines
(DomainProxy collection) Virtual machines associated with this node.
See Also:
DomainProxy


 
Constructor Detail

Node

Node()


 
Method Detail

getArchitecture

String getArchitecture()
This node's processor architecture.


getClasses

Set getClasses()
(String collection) The classes that this node can be scheduled for.
See Also:
String


getFeaturesReported

Set getFeaturesReported()
(String collection) The features this node advertises. This can be used to define node sets.
See Also:
String


getId

String getId()
The unique identifier of this node. Note: this field is not user-assigned and is generated by the database.


getIndex

Integer getIndex()
The index for this node as reported by the resource manager.


getIpAddress

String getIpAddress()
This node's IPv4 address.


getIsHypervisor

Boolean getIsHypervisor()
True if the node is a hypervisor, false otherwise. This is based on the NodeOperatingSystemInformation#hypervisorType#hypervisorType field. If hypervisorType is present, the node is a hypervisor. If it is null, then it is not a hypervisor.


getJobs

Set getJobs()
(DomainProxy collection) Jobs associated with this node.
See Also:
DomainProxy


getLastUpdatedDate

Date getLastUpdatedDate()
The timestamp of the last moment when this node was updated. There is no guarantee that all user modifications to a node would be picked up. This will also be changed every RMPOLLINTERVAL even if a resource manager does not report information on this node.


getMessages

Set getMessages()
(Message collection) The list of messages attached to this node. They can be attached by admins, the resource manager layer, or triggers. Valid during PUT.
See Also:
Message


getMetrics

Map getMetrics()
(Map of String => Double) Metrics are the measurable, quantitative, and changing aspects of this node. They are used to define workload placement, attach triggers, etc. There are some built-in metrics: Valid during PUT.
See Also:
Double


getMigrationDisabled

Boolean getMigrationDisabled()
True if VM migration is disabled on this node.


getName

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


getOperatingSystem

NodeOperatingSystemInformation getOperatingSystem()
Describes the current or expected operating system image information for this node.


getPartition

String getPartition()
The partition this node belongs to. Valid during PUT.


getProcessorSpeed

Integer getProcessorSpeed()
The speed, in MHz, or the processors on this node.


getProfilingEnabled

Boolean getProfilingEnabled()
Indicates whether historical data gathering and reporting is enabled for this node. This is also controlled by the same setting on the default node (i.e. all nodes). If set to false (default), node statistics are not gathered.


getRack

Integer getRack()
The rack where this node is located in the datacenter/cluster.


getReservations

Set getReservations()
(DomainProxy collection) Reservations associated with this node.
See Also:
DomainProxy


getResourceManagerMessages

Map getResourceManagerMessages()
(Map of String => String) The resource manager messages for this node. Each key is the name of a resource manager, and the value is the message that the resource manager has posted onto the node.
See Also:
Map


getResourceManagers

Set getResourceManagers()
(NodeResourceManager collection) The resource managers that are reporting or have previously reported this node. Each object also contains information on the resource manager reports.
See Also:
NodeResourceManager


getResources

Map getResources()
(Map of String => Resource) Contains references of a string representing a resource name to a resource object detailing the amount of the resource that is available, configured, etc.
Each key is the name of the resource, which equates to the generic resource identifier or one of "processors", "memory", "disk", or "swap". This name may be used as an id in the resource types web service.
See Also:
Resource


getSlot

Integer getSlot()
The slot in the rack where this node is located.


getStates

NodeStateInformation getStates()
This node's state. Valid during PUT.


getTriggers

Set getTriggers()
(DomainProxy collection) Triggers associated with this node.
See Also:
DomainProxy


getType

NodeType getType()
The type of this node is governed by the types of resources it offers.


getVariables

Map getVariables()
(Map of String => String) Variables is a map of key-value pairs, synonymous, but not directly related to, environment variables. They provide the mechanism to store arbitrary metdata which is useful to external systems in memory on this node. Valid during PUT.
See Also:
Map


getVirtualContainers

Set getVirtualContainers()
(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this node.
See Also:
DomainProxy


getVirtualMachines

Set getVirtualMachines()
(DomainProxy collection) Virtual machines associated with this node.
See Also:
DomainProxy


setArchitecture

void setArchitecture(String architecture)
This node's processor architecture.


setClasses

void setClasses(Set classes)
(String collection) The classes that this node can be scheduled for.
See Also:
String


setFeaturesReported

void setFeaturesReported(Set featuresReported)
(String collection) The features this node advertises. This can be used to define node sets.
See Also:
String


setId

void setId(String id)
The unique identifier of this node. Note: this field is not user-assigned and is generated by the database.


setIndex

void setIndex(Integer index)
The index for this node as reported by the resource manager.


setIpAddress

void setIpAddress(String ipAddress)
This node's IPv4 address.


setIsHypervisor

void setIsHypervisor(Boolean isHypervisor)
True if the node is a hypervisor, false otherwise. This is based on the NodeOperatingSystemInformation#hypervisorType#hypervisorType field. If hypervisorType is present, the node is a hypervisor. If it is null, then it is not a hypervisor.


setJobs

void setJobs(Set jobs)
(DomainProxy collection) Jobs associated with this node.
See Also:
DomainProxy


setLastUpdatedDate

void setLastUpdatedDate(Date lastUpdatedDate)
The timestamp of the last moment when this node was updated. There is no guarantee that all user modifications to a node would be picked up. This will also be changed every RMPOLLINTERVAL even if a resource manager does not report information on this node.


setMessages

void setMessages(Set messages)
(Message collection) The list of messages attached to this node. They can be attached by admins, the resource manager layer, or triggers. Valid during PUT.
See Also:
Message


setMetrics

void setMetrics(Map metrics)
(Map of String => Double) Metrics are the measurable, quantitative, and changing aspects of this node. They are used to define workload placement, attach triggers, etc. There are some built-in metrics: Valid during PUT.
See Also:
Double


setMigrationDisabled

void setMigrationDisabled(Boolean migrationDisabled)
True if VM migration is disabled on this node.


setName

void setName(String name)
The name of this node. This name is unique per instance of Moab Workload Manager (i.e. not globally).


setOperatingSystem

void setOperatingSystem(NodeOperatingSystemInformation operatingSystem)
Describes the current or expected operating system image information for this node.


setPartition

void setPartition(String partition)
The partition this node belongs to. Valid during PUT.


setProcessorSpeed

void setProcessorSpeed(Integer processorSpeed)
The speed, in MHz, or the processors on this node.


setProfilingEnabled

void setProfilingEnabled(Boolean profilingEnabled)
Indicates whether historical data gathering and reporting is enabled for this node. This is also controlled by the same setting on the default node (i.e. all nodes). If set to false (default), node statistics are not gathered.


setRack

void setRack(Integer rack)
The rack where this node is located in the datacenter/cluster.


setReservations

void setReservations(Set reservations)
(DomainProxy collection) Reservations associated with this node.
See Also:
DomainProxy


setResourceManagerMessages

void setResourceManagerMessages(Map resourceManagerMessages)
(Map of String => String) The resource manager messages for this node. Each key is the name of a resource manager, and the value is the message that the resource manager has posted onto the node.
See Also:
Map


setResourceManagers

void setResourceManagers(Set resourceManagers)
(NodeResourceManager collection) The resource managers that are reporting or have previously reported this node. Each object also contains information on the resource manager reports.
See Also:
NodeResourceManager


setResources

void setResources(Map resources)
(Map of String => Resource) Contains references of a string representing a resource name to a resource object detailing the amount of the resource that is available, configured, etc.
Each key is the name of the resource, which equates to the generic resource identifier or one of "processors", "memory", "disk", or "swap". This name may be used as an id in the resource types web service.
See Also:
Resource


setSlot

void setSlot(Integer slot)
The slot in the rack where this node is located.


setStates

void setStates(NodeStateInformation states)
This node's state. Valid during PUT.


setTriggers

void setTriggers(Set triggers)
(DomainProxy collection) Triggers associated with this node.
See Also:
DomainProxy


setType

void setType(NodeType type)
The type of this node is governed by the types of resources it offers.


setVariables

void setVariables(Map variables)
(Map of String => String) Variables is a map of key-value pairs, synonymous, but not directly related to, environment variables. They provide the mechanism to store arbitrary metdata which is useful to external systems in memory on this node. Valid during PUT.
See Also:
Map


setVirtualContainers

void setVirtualContainers(Set virtualContainers)
(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this node.
See Also:
DomainProxy


setVirtualMachines

void setVirtualMachines(Set virtualMachines)
(DomainProxy collection) Virtual machines associated with this node.
See Also:
DomainProxy


toString

String toString()


 

Groovy Documentation