Package org.jenkinsci.plugins.vsphere.tools

Class VSphereHostSelection.HostCandidate

java.lang.Object

org.jenkinsci.plugins.vsphere.tools.VSphereHostSelection.HostCandidate

Enclosing class:

VSphereHostSelection

public static final class VSphereHostSelection.HostCandidate
extends Object

Describes one candidate host's name, availability and current load, as needed to decide whether/how favourably it can be used for a new clone.

Constructor Summary

Constructors

Constructor	Description
HostCandidate(String name, boolean connected, boolean inMaintenanceMode, Integer cpuUsageMhz, int cpuCapacityMhz, Integer memUsageMB, long memCapacityMB)
HostCandidate(String name, boolean connected, boolean inMaintenanceMode, Integer cpuUsageMhz, int cpuCapacityMhz, Integer memUsageMB, long memCapacityMB, int cpuCores)

Method Summary

Modifier and Type	Method	Description
double	freeCpuFraction()	Unused CPU as a share (0..1) of the host's CPU capacity.
double	freeCpuMhz()	Unused CPU in MHz (0 if usage is unknown).
double	freeMemFraction()	Unused memory as a share (0..1) of the host's memory.
double	freeMemMB()	Unused memory in MB (0 if usage is unknown).
int	getCpuCapacityMhz()
int	getCpuCores()	Number of physical CPU cores on the host; 0 if unknown.
Integer	getCpuUsageMhz()
long	getMemCapacityMB()
Integer	getMemUsageMB()
String	getName()
boolean	isConnected()
boolean	isInMaintenanceMode()
boolean	isUsable()	True if the host is currently usable at all (connected and not in maintenance mode), regardless of load.
Double	loadFraction()	Fraction of capacity currently in use, taking the higher (more constrained) of CPU and memory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HostCandidate

public HostCandidate(String name,
 boolean connected,
 boolean inMaintenanceMode,
 Integer cpuUsageMhz,
 int cpuCapacityMhz,
 Integer memUsageMB,
 long memCapacityMB)

HostCandidate

public HostCandidate(String name,
 boolean connected,
 boolean inMaintenanceMode,
 Integer cpuUsageMhz,
 int cpuCapacityMhz,
 Integer memUsageMB,
 long memCapacityMB,
 int cpuCores)

Method Details

getName

public String getName()

isConnected

public boolean isConnected()

isInMaintenanceMode

public boolean isInMaintenanceMode()

getCpuUsageMhz

public Integer getCpuUsageMhz()

getCpuCapacityMhz

public int getCpuCapacityMhz()

getMemUsageMB

public Integer getMemUsageMB()

getMemCapacityMB

public long getMemCapacityMB()

getCpuCores

public int getCpuCores()

Number of physical CPU cores on the host; 0 if unknown.

loadFraction

public Double loadFraction()

Fraction of capacity currently in use, taking the higher (more constrained) of CPU and memory. Returns null if usage stats are missing (stale/unavailable), so the host can be excluded rather than mis-ranked.

freeCpuMhz

public double freeCpuMhz()

Unused CPU in MHz (0 if usage is unknown).

freeMemMB

public double freeMemMB()

Unused memory in MB (0 if usage is unknown).

freeCpuFraction

public double freeCpuFraction()

Unused CPU as a share (0..1) of the host's CPU capacity.

freeMemFraction

public double freeMemFraction()

Unused memory as a share (0..1) of the host's memory.

isUsable

public boolean isUsable()

True if the host is currently usable at all (connected and not in maintenance mode), regardless of load.