Package hudson.slaves

Class NodeProvisioner.StrategyState

java.lang.Object

hudson.slaves.NodeProvisioner.StrategyState

Enclosing class:

NodeProvisioner

public final class NodeProvisioner.StrategyState
extends Object

Parameter object for NodeProvisioner.Strategy. Intentionally non-static as we need to reference some fields in NodeProvisioner

Since:

1.588

Method Summary

Modifier and Type	Method	Description
int	getAdditionalPlannedCapacity()	The additional planned capacity for this getLabel() and provisioned by previous strategies during the current updating of the NodeProvisioner.
float	getAvailableExecutorsLatest()	The time series average number of available executors for this getLabel()
float	getBusyExecutorsLatest()	The time series average number of busy executors for this getLabel()
float	getConnectingExecutorsLatest()	The time series average number of connecting executors for this getLabel()
float	getDefinedExecutorsLatest()	The time series average number of defined executors for this getLabel()
float	getIdleExecutorsLatest()	The time series average number of idle executors for this getLabel()
float	getIdleLatest()	Deprecated. use getAvailableExecutorsLatest()
int	getIdleSnapshot()	Deprecated. use getSnapshot(), LoadStatistics.LoadStatisticsSnapshot.getAvailableExecutors()
Label	getLabel()	The label under consideration.
float	getOnlineExecutorsLatest()	The time series average number of online executors for this getLabel()
float	getPlannedCapacityLatest()	The time series average planned capacity for this getLabel().
int	getPlannedCapacitySnapshot()	The planned capacity for this getLabel().
float	getQueueLengthLatest()	The time series average number of items in the queue requiring this getLabel().
int	getQueueLengthSnapshot()	Deprecated. use getSnapshot(), LoadStatistics.LoadStatisticsSnapshot.getQueueLength()
LoadStatistics.LoadStatisticsSnapshot	getSnapshot()	The current snapshot of the load statistics for this getLabel().
float	getTotalLatest()	Deprecated. use getOnlineExecutorsLatest()
int	getTotalSnapshot()	Deprecated. use getSnapshot(), LoadStatistics.LoadStatisticsSnapshot.getOnlineExecutors()
void	recordPendingLaunches(NodeProvisioner.PlannedNode... plannedNodes)	If a NodeProvisioner.Strategy takes some provisioning action, it should record and NodeProvisioner.PlannedNode instances by calling this method.
void	recordPendingLaunches(Collection<NodeProvisioner.PlannedNode> plannedNodes)	If a NodeProvisioner.Strategy takes some provisioning action, it should record and NodeProvisioner.PlannedNode instances by calling this method.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getLabel

@CheckForNull
public Label getLabel()

The label under consideration.

getSnapshot

public LoadStatistics.LoadStatisticsSnapshot getSnapshot()

The current snapshot of the load statistics for this getLabel().

Since:

1.607

getQueueLengthSnapshot

@Deprecated
public int getQueueLengthSnapshot()

Deprecated.

use getSnapshot(), LoadStatistics.LoadStatisticsSnapshot.getQueueLength()

The number of items in the queue requiring this getLabel().

getPlannedCapacitySnapshot

public int getPlannedCapacitySnapshot()

The planned capacity for this getLabel().

getIdleSnapshot

@Deprecated
public int getIdleSnapshot()

Deprecated.

use getSnapshot(), LoadStatistics.LoadStatisticsSnapshot.getAvailableExecutors()

The number of idle executors for this getLabel()

getTotalSnapshot

@Deprecated
public int getTotalSnapshot()

Deprecated.

use getSnapshot(), LoadStatistics.LoadStatisticsSnapshot.getOnlineExecutors()

The total number of executors for this getLabel()

getAdditionalPlannedCapacity

public int getAdditionalPlannedCapacity()

The additional planned capacity for this getLabel() and provisioned by previous strategies during the current updating of the NodeProvisioner.

getQueueLengthLatest

public float getQueueLengthLatest()

The time series average number of items in the queue requiring this getLabel().

getPlannedCapacityLatest

public float getPlannedCapacityLatest()

The time series average planned capacity for this getLabel().

getIdleLatest

@Deprecated
public float getIdleLatest()

Deprecated.

use getAvailableExecutorsLatest()

The time series average number of idle executors for this getLabel()

getTotalLatest

@Deprecated
public float getTotalLatest()

Deprecated.

use getOnlineExecutorsLatest()

The time series average total number of executors for this getLabel()

getDefinedExecutorsLatest

public float getDefinedExecutorsLatest()

The time series average number of defined executors for this getLabel()

Since:

1.607

getOnlineExecutorsLatest

public float getOnlineExecutorsLatest()

The time series average number of online executors for this getLabel()

Since:

1.607

getConnectingExecutorsLatest

public float getConnectingExecutorsLatest()

The time series average number of connecting executors for this getLabel()

Since:

1.607

getBusyExecutorsLatest

public float getBusyExecutorsLatest()

The time series average number of busy executors for this getLabel()

Since:

1.607

getIdleExecutorsLatest

public float getIdleExecutorsLatest()

The time series average number of idle executors for this getLabel()

Since:

1.607

getAvailableExecutorsLatest

public float getAvailableExecutorsLatest()

The time series average number of available executors for this getLabel()

Since:

1.607

recordPendingLaunches

public void recordPendingLaunches(NodeProvisioner.PlannedNode... plannedNodes)

If a NodeProvisioner.Strategy takes some provisioning action, it should record and NodeProvisioner.PlannedNode instances by calling this method.

Parameters:

plannedNodes - the NodeProvisioner.PlannedNode instances.

recordPendingLaunches

public void recordPendingLaunches(Collection<NodeProvisioner.PlannedNode> plannedNodes)

If a NodeProvisioner.Strategy takes some provisioning action, it should record and NodeProvisioner.PlannedNode instances by calling this method.

Parameters:

plannedNodes - the NodeProvisioner.PlannedNode instances.

toString

public String toString()

Overrides:

toString in class Object