Lean  $LEAN_TAG$
QuantConnect.Api.SKU Class Reference

Class for generating a SKU for a node with a given configuration Every SKU is made up of 3 variables: More...

Public Member Functions

 SKU (int cores, int memory, NodeType target)
 Constructs a SKU object out of the provided node configuration More...
 
override string ToString ()
 Generates the SKU string for API calls based on the specifications of the node More...
 

Properties

int Cores [get, set]
 The number of CPU cores in the node More...
 
int Memory [get, set]
 Size of RAM in GB of the Node More...
 
NodeType Target [get, set]
 Target environment for the node More...
 

Detailed Description

Class for generating a SKU for a node with a given configuration Every SKU is made up of 3 variables:

  • Target environment (L for live, B for Backtest, R for Research)
  • CPU core count
  • Dedicated RAM (GB)

Definition at line 176 of file Nodes.cs.

Constructor & Destructor Documentation

◆ SKU()

QuantConnect.Api.SKU.SKU ( int  cores,
int  memory,
NodeType  target 
)

Constructs a SKU object out of the provided node configuration

Parameters
coresNumber of cores
memorySize of RAM in GBs
targetTarget Environment Live/Backtest/Research

Definition at line 199 of file Nodes.cs.

Member Function Documentation

◆ ToString()

override string QuantConnect.Api.SKU.ToString ( )

Generates the SKU string for API calls based on the specifications of the node

Returns
String representation of the SKU

Definition at line 210 of file Nodes.cs.

Property Documentation

◆ Cores

int QuantConnect.Api.SKU.Cores
getset

The number of CPU cores in the node

Definition at line 181 of file Nodes.cs.

◆ Memory

int QuantConnect.Api.SKU.Memory
getset

Size of RAM in GB of the Node

Definition at line 186 of file Nodes.cs.

◆ Target

NodeType QuantConnect.Api.SKU.Target
getset

Target environment for the node

Definition at line 191 of file Nodes.cs.


The documentation for this class was generated from the following file: