RmQueriedNodepool (Apache UIMA DUCC Java SDK 3.0.0 User-Level API Documentation)

java.lang.Object
- org.apache.uima.ducc.common.admin.event.RmQueriedNodepool

All Implemented Interfaces:

Serializable
```
public class RmQueriedNodepool
extends Object
implements Serializable
```
This class returns details about the current state of each nodepool. Regarding the getFreeMachines and getVirtualMachines calls, these two arrays together show the available memory that is free and schedulable. For example, if a 48GB machine has a 15GB process scheduled on it (assuming a share quantum of 15GB), the response will show one 30GB virtual machine, and the expected count of 48GB machines will be reduced by one.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RmQueriedNodepool()
Used by RM only.

Constructors
Constructor and Description
`RmQueriedNodepool()` Used by RM only.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int[]`	`getAllMachines()`
`int`	`getDead()`
`int[]`	`getFreeMachines()`
`String`	`getName()`
`int`	`getOffline()`
`int`	`getOnline()`
`int[]`	`getOnlineMachines()`
`int`	`getSharesAvailable()`
`int`	`getSharesFree()`
`int[]`	`getVirtualMachines()`
`void`	`setAllMachines(int[] allMachines)`
`void`	`setDead(int dead)`
`void`	`setFreeMachines(int[] freeMachines)`
`void`	`setName(String name)`
`void`	`setOffline(int offline)`
`void`	`setOnline(int online)`
`void`	`setOnlineMachines(int[] onlineMachines)`
`void`	`setSharesAvailable(int sharesAvailable)`
`void`	`setSharesFree(int sharesFree)`
`void`	`setVirtualMachines(int[] virtualMachines)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RmQueriedNodepool
```
public RmQueriedNodepool()
```
    Used by RM only.
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    
    the name of the nodepool
  - setName
```
public void setName(String name)
```
  - getOnline
```
public int getOnline()
```
    Returns:
    
    the number of online, schedulable hosts in the nodepool.
  - setOnline
```
public void setOnline(int online)
```
  - getDead
```
public int getDead()
```
    Returns:
    
    the number of hosts which once were responding but have stopped sending heartbeats.
  - setDead
```
public void setDead(int dead)
```
  - getOffline
```
public int getOffline()
```
    Returns:
    
    the number of hosts which are varied offline.
  - setOffline
```
public void setOffline(int offline)
```
  - getSharesAvailable
```
public int getSharesAvailable()
```
    Returns:
    
    the total number of schedulable quantum shares in the nodepool.
  - setSharesAvailable
```
public void setSharesAvailable(int sharesAvailable)
```
  - getSharesFree
```
public int getSharesFree()
```
    Returns:
    
    the number of unused quantum shares in the nodepool.
  - setSharesFree
```
public void setSharesFree(int sharesFree)
```
  - getAllMachines
```
public int[] getAllMachines()
```
    Returns:
    
    an array, indexed by multiples of the share quantum, showing the total number of machines known to the nodepool, regardless of status, whose memory capacity matches that multiple of the quantum.
  - setAllMachines
```
public void setAllMachines(int[] allMachines)
```
  - getOnlineMachines
```
public int[] getOnlineMachines()
```
    Returns:
    
    an array, indexed by multiples of the share quantum, showing the total number of machines which are online and schedulable whose memory capacity matches that multiple of the quantum.
  - setOnlineMachines
```
public void setOnlineMachines(int[] onlineMachines)
```
  - getFreeMachines
```
public int[] getFreeMachines()
```
    Returns:
    
    an array, indexed by multiples of the share quantum, showing the total number of physical machines which have nothing scheduled on them.
  - setFreeMachines
```
public void setFreeMachines(int[] freeMachines)
```
  - getVirtualMachines
```
public int[] getVirtualMachines()
```
    Returns:
    
    an array, indexed by multiples of the share quantum, showing the total number of shares free on machines that to have something scheduled on them.
  - setVirtualMachines
```
public void setVirtualMachines(int[] virtualMachines)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Methods inherited from class java.lang.Object

RmQueriedNodepool

getName

setName

getOnline

setOnline

getDead

setDead

getOffline

setOffline

getSharesAvailable

setSharesAvailable

getSharesFree

setSharesFree

getAllMachines

setAllMachines

getOnlineMachines

setOnlineMachines

getFreeMachines

setFreeMachines

getVirtualMachines

setVirtualMachines

toString