Class capacity

Hierarchy

capacity

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new capacity(config: GridClientConfig): capacity

- Defined in packages/grid_client/src/modules/capacity.ts:19
Parameters
- config: GridClientConfig
Returns capacity

Properties

config

config: GridClientConfig

nodes

nodes: Nodes

Methods

checkFarmHasFreePublicIps

checkFarmHasFreePublicIps(options?: FarmHasFreePublicIPsModel): Promise<boolean>

- Defined in packages/grid_client/src/modules/capacity.ts:91
Parameters
- Optional options: FarmHasFreePublicIPsModel
Returns Promise<boolean>

checkNodeCapacityPool

checkNodeCapacityPool(options: CapacityPoolCheckModel): Promise<boolean>

- Defined in packages/grid_client/src/modules/capacity.ts:126
Checks the storage pool capacity of a node for different disk types.

throws
{Error} - If there is an error in getting the node's information or if the required deployment can't be fitted.

Parameters
- options: CapacityPoolCheckModel
  
  An object containing the required disk sizes and node ID for capacity pool check.
Returns Promise<boolean>
- True if the node has enough capacity, otherwise false.

filterNodes

filterNodes(options?: FilterOptions): Promise<NodeInfo[]>

- Defined in packages/grid_client/src/modules/capacity.ts:75
Parameters
- Optional options: FilterOptions
Returns Promise<NodeInfo[]>

getAllFarms

getAllFarms(): Promise<FarmInfo[]>

- Defined in packages/grid_client/src/modules/capacity.ts:35
Returns Promise<FarmInfo[]>

getAllNodes

getAllNodes(): Promise<NodeInfo[]>

- Defined in packages/grid_client/src/modules/capacity.ts:40
Returns Promise<NodeInfo[]>

getFarmIdFromFarmName

getFarmIdFromFarmName(options?: FarmIdFromFarmNameModel): Promise<number>

- Defined in packages/grid_client/src/modules/capacity.ts:109
Parameters
- Optional options: FarmIdFromFarmNameModel
Returns Promise<number>

getFarms

getFarms(options?: FarmsGetModel): Promise<FarmInfo[]>

- Defined in packages/grid_client/src/modules/capacity.ts:24
Parameters
- options: FarmsGetModel = {}
Returns Promise<FarmInfo[]>

getNodeFreeResources

getNodeFreeResources(options?: NodeFreeResourcesModel): Promise<NodeResources>

- Defined in packages/grid_client/src/modules/capacity.ts:103
Parameters
- Optional options: NodeFreeResourcesModel
Returns Promise<NodeResources>

getNodes

getNodes(options?: NodesGetModel): Promise<NodeInfo[]>

- Defined in packages/grid_client/src/modules/capacity.ts:30
Parameters
- options: NodesGetModel = {}
Returns Promise<NodeInfo[]>

getNodesByFarmId

getNodesByFarmId(options?: NodesByFarmIdModel): Promise<NodeInfo[]>

- Defined in packages/grid_client/src/modules/capacity.ts:97
Parameters
- Optional options: NodesByFarmIdModel
Returns Promise<NodeInfo[]>

Private useFarmerBot

useFarmerBot(options?: FilterOptions): Promise<NodeInfo[]>

- Defined in packages/grid_client/src/modules/capacity.ts:44
Parameters
- Optional options: FilterOptions
Returns Promise<NodeInfo[]>

Generated using TypeDoc