Lean  $LEAN_TAG$
QuantConnect.Api.Node Class Reference

Node class built for API endpoints nodes/read and nodes/create. Converts JSON properties from API response into data members for the class. Contains all relevant information on a Node to interact through API endpoints. More...

Properties

decimal Speed [get, set]
 The nodes cpu clock speed in GHz. More...
 
NodePrices Prices [get, set]
 The monthly and yearly prices of the node in US dollars, see NodePrices for type. More...
 
int CpuCount [get, set]
 CPU core count of node. More...
 
int HasGPU [get, set]
 Indicate if the node has GPU (1) or not (0) More...
 
decimal Ram [get, set]
 Size of RAM in Gigabytes. More...
 
string Name [get, set]
 Name of the node. More...
 
string SKU [get, set]
 Node type identifier for configuration. More...
 
string Description [get, set]
 Description of the node. More...
 
string UsedBy [get, set]
 User currently using the node. More...
 
string UserProfile [get, set]
 URL of the user using the node More...
 
string ProjectName [get, set]
 Project the node is being used for. More...
 
int? ProjectId [get, set]
 Id of the project the node is being used for. More...
 
bool Busy [get, set]
 Indicates if the node is currently busy. More...
 
string Id [get, set]
 Full ID of node. More...
 
int Assets [get, set]
 Maximum number of assets recommended for this node. More...
 
string Host [get, set]
 Node host. More...
 
bool Active [get, set]
 Indicate if this is the active node. The project will use this node if it's not busy. More...
 

Detailed Description

Node class built for API endpoints nodes/read and nodes/create. Converts JSON properties from API response into data members for the class. Contains all relevant information on a Node to interact through API endpoints.

Definition at line 26 of file Nodes.cs.

Property Documentation

◆ Speed

decimal QuantConnect.Api.Node.Speed
getset

The nodes cpu clock speed in GHz.

Definition at line 32 of file Nodes.cs.

◆ Prices

NodePrices QuantConnect.Api.Node.Prices
getset

The monthly and yearly prices of the node in US dollars, see NodePrices for type.

Definition at line 39 of file Nodes.cs.

◆ CpuCount

int QuantConnect.Api.Node.CpuCount
getset

CPU core count of node.

Definition at line 45 of file Nodes.cs.

◆ HasGPU

int QuantConnect.Api.Node.HasGPU
getset

Indicate if the node has GPU (1) or not (0)

Definition at line 51 of file Nodes.cs.

◆ Ram

decimal QuantConnect.Api.Node.Ram
getset

Size of RAM in Gigabytes.

Definition at line 57 of file Nodes.cs.

◆ Name

string QuantConnect.Api.Node.Name
getset

Name of the node.

Definition at line 63 of file Nodes.cs.

◆ SKU

string QuantConnect.Api.Node.SKU
getset

Node type identifier for configuration.

Definition at line 69 of file Nodes.cs.

◆ Description

string QuantConnect.Api.Node.Description
getset

Description of the node.

Definition at line 75 of file Nodes.cs.

◆ UsedBy

string QuantConnect.Api.Node.UsedBy
getset

User currently using the node.

Definition at line 81 of file Nodes.cs.

◆ UserProfile

string QuantConnect.Api.Node.UserProfile
getset

URL of the user using the node

Definition at line 87 of file Nodes.cs.

◆ ProjectName

string QuantConnect.Api.Node.ProjectName
getset

Project the node is being used for.

Definition at line 93 of file Nodes.cs.

◆ ProjectId

int? QuantConnect.Api.Node.ProjectId
getset

Id of the project the node is being used for.

Definition at line 99 of file Nodes.cs.

◆ Busy

bool QuantConnect.Api.Node.Busy
getset

Indicates if the node is currently busy.

Definition at line 105 of file Nodes.cs.

◆ Id

string QuantConnect.Api.Node.Id
getset

Full ID of node.

Definition at line 111 of file Nodes.cs.

◆ Assets

int QuantConnect.Api.Node.Assets
getset

Maximum number of assets recommended for this node.

Definition at line 117 of file Nodes.cs.

◆ Host

string QuantConnect.Api.Node.Host
getset

Node host.

Definition at line 123 of file Nodes.cs.

◆ Active

bool QuantConnect.Api.Node.Active
getset

Indicate if this is the active node. The project will use this node if it's not busy.

Definition at line 129 of file Nodes.cs.


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