RmQueriedMachine (Apache UIMA DUCC: uima-ducc-common 2.0.0 API)

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

All Implemented Interfaces:

Serializable
```
public class RmQueriedMachine
extends Object
implements Serializable
```
This object represents details of a host as seen by the Resource Manager.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`RmQueriedMachine(String name, String nodepoolId, long memory, int order, boolean blacklisted)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addShare(RmQueriedShare rqs)`
`String`	`getId()` Returns the name of the machin.
`long`	`getMemory()` Returns the amount of RAM in KB (kilobytes) on the machine.
`int`	`getShareOrder()` Returns the share order of the machine.
`List<RmQueriedShare>`	`getShares()` Return the list of shares scheduled to this host.
`boolean`	`isBlacklisted()` Returns whether the machine is blacklisted.
`boolean`	`isOnline()` Returns whether the machine is varied online.
`boolean`	`isResponsive()` Indicates whether the machine is sending heartbeats.
`void`	`setOffline()`
`void`	`setUnresponsive()`
`String`	`toString()`

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

- Constructor Detail
  - RmQueriedMachine
```
public RmQueriedMachine(String name,
                String nodepoolId,
                long memory,
                int order,
                boolean blacklisted)
```
- Method Detail
  - setOffline
```
public void setOffline()
```
  - setUnresponsive
```
public void setUnresponsive()
```
  - addShare
```
public void addShare(RmQueriedShare rqs)
```
  - getShares
```
public List<RmQueriedShare> getShares()
```
    Return the list of shares scheduled to this host.
    
    Returns:
    The list of shares.
  - getId
```
public String getId()
```
    Returns the name of the machin.
    
    Returns:
    the name of the machine.
  - getMemory
```
public long getMemory()
```
    Returns the amount of RAM in KB (kilobytes) on the machine.
    
    Returns:
    the amount of RAM in the machine, in kilobytes.
  - getShareOrder
```
public int getShareOrder()
```
    Returns the share order of the machine.
    
    Returns:
    the number of quantum shares supported by the machine. For example, if the share quantum is 15GB, a 48GB machine is of order 3.
  - isBlacklisted
```
public boolean isBlacklisted()
```
    Returns whether the machine is blacklisted.
    
    Returns:
    whether the host contains blacklisted processes. A blacklisted process is one whose characteristics no longer match the machine. For example, after reconfiguration, this may be an illegal assignemnt for the request. Until such time as the request is (externally) removed, the RM has to account for the space by maintaining records on the blacklisted work. If a machine is blacklisted, it is not schedulable for new work.
  - isOnline
```
public boolean isOnline()
```
    Returns whether the machine is varied online.
    
    Returns:
    true if the machine is varied online and false otherwise. Note that a machine might "not varied offline", but not responsive (not sending heartbeats).
  - isResponsive
```
public boolean isResponsive()
```
    Indicates whether the machine is sending heartbeats.
    
    Returns:
    true if the machine is sending heartbeats. Note that a machine might be sending heartbeats but be varied offline or blacklisted, and hence not schedulable.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RmQueriedMachine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RmQueriedMachine

Method Detail

setOffline

setUnresponsive

addShare

getShares

getId

getMemory

getShareOrder

isBlacklisted

isOnline

isResponsive

toString