QuantConnect.Packets.LiveNodePacket Class Reference
Live job task packet: container for any live specific job variables More...
Inheritance diagram for QuantConnect.Packets.LiveNodePacket:
Public Member Functions | |
| LiveNodePacket () | |
| Default constructor for JSON of the Live Task Packet More... | |
 Public Member Functions inherited from QuantConnect.Packets.AlgorithmNodePacket | |
| AlgorithmNodePacket (PacketType type) | |
| Default constructor for the algorithm node: More... | |
| string | GetAlgorithmName () |
| Gets a unique name for the algorithm defined by this packet More... | |
| Public Member Functions inherited from QuantConnect.Packets.Packet | |
| Packet (PacketType type) | |
| Initialize the base class and setup the packet type. More... | |
Public Attributes | |
| string | DeployId = "" |
| Deploy Id for this live algorithm. More... | |
| string | Brokerage = "" |
| String name of the brokerage we're trading with More... | |
| Dictionary< string, string > | BrokerageData = new Dictionary<string, string>() |
| String-String Dictionary of Brokerage Data for this Live Job More... | |
| string | DataQueueHandler = "" |
| String name of the DataQueueHandler or LiveDataProvider we're running with More... | |
| string | DataChannelProvider = "" |
| String name of the DataChannelProvider we're running with More... | |
| bool | DisableAcknowledgement |
| Gets flag indicating whether or not the message should be acknowledged and removed from the queue More... | |
| HashSet< string > | NotificationEvents |
| A list of event types to generate notifications for, which will use NotificationTargets More... | |
| List< Notification > | NotificationTargets |
| A list of notification targets to use More... | |
| HashSet< string > | LiveDataTypes |
| List of real time data types available in the live trading environment More... | |
| Public Attributes inherited from QuantConnect.Packets.AlgorithmNodePacket | |
| string | HostName |
| The host name to use if any More... | |
| int | UserId = 0 |
| User Id placing request More... | |
| string | UserToken = "" |
| User API Token. | |
| string | OrganizationId = "" |
| User Organization Id. | |
| int | ProjectId = 0 |
| Project Id of the request More... | |
| string | ProjectName |
| Project name of the request More... | |
| string | SessionId = "" |
| User session Id for authentication More... | |
| Language | Language = Language.CSharp |
| Language flag: Currently represents IL code or Dynamic Scripted Types. More... | |
| ServerType | ServerType = ServerType.Server512 |
| Server type for the deployment (512, 1024, 2048) More... | |
| string | CompileId = "" |
| Unique compile id of this backtest More... | |
| string | Version |
| Version number identifier for the lean engine. More... | |
| bool | Redelivered = false |
| An algorithm packet which has already been run and is being redelivered on this node. In this event we don't want to relaunch the task as it may result in unexpected behaviour for user. More... | |
| byte[] | Algorithm = new byte[] { } |
| Algorithm binary with zip of contents More... | |
| string | RequestSource = "WebIDE" |
| Request source - Web IDE or API - for controling result handler behaviour More... | |
| Controls | Controls |
| Specifies values to control algorithm limits More... | |
| Dictionary< string, string > | Parameters = new Dictionary<string, string>() |
| The parameter values used to set algorithm parameters More... | |
| string | HistoryProvider = "" |
| String name of the HistoryProvider we're running with More... | |
| DeploymentTarget | DeploymentTarget |
| Deployment target, either local or cloud. More... | |
Properties | |
| override AlgorithmMode | AlgorithmMode [get] |
| Algorithm running mode. More... | |
| Properties inherited from QuantConnect.Packets.AlgorithmNodePacket | |
| string | AlgorithmId [get] |
| Algorithm Id - BacktestId or DeployId - Common Id property between packets. More... | |
| int | RamAllocation [get] |
| The maximum amount of RAM (in MB) this algorithm is allowed to utilize More... | |
| virtual AlgorithmMode | AlgorithmMode = AlgorithmMode.Backtesting [get] |
| Algorithm running mode. More... | |
| Properties inherited from QuantConnect.Packets.PythonEnvironmentPacket | |
| string | PythonVirtualEnvironment [get, set] |
| Virtual environment ID used to find PythonEvironments Ideally MD5, but environment names work as well. More... | |
| Properties inherited from QuantConnect.Packets.Packet | |
| PacketType | Type = PacketType.None [get, set] |
| Packet type defined by a string enum More... | |
| virtual string | Channel = "" [get, set] |
| User unique specific channel endpoint to send the packets More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from QuantConnect.Packets.PythonEnvironmentPacket | |
| PythonEnvironmentPacket (PacketType type) | |
| Default constructor for a PythonEnvironmentPacket More... | |
Detailed Description
Live job task packet: container for any live specific job variables
Definition at line 26 of file LiveNodePacket.cs.
Constructor & Destructor Documentation
◆ LiveNodePacket()
| QuantConnect.Packets.LiveNodePacket.LiveNodePacket | ( | ) |
Default constructor for JSON of the Live Task Packet
Definition at line 88 of file LiveNodePacket.cs.
Member Data Documentation
◆ DeployId
| string QuantConnect.Packets.LiveNodePacket.DeployId = "" |
Deploy Id for this live algorithm.
Definition at line 31 of file LiveNodePacket.cs.
◆ Brokerage
| string QuantConnect.Packets.LiveNodePacket.Brokerage = "" |
String name of the brokerage we're trading with
Definition at line 36 of file LiveNodePacket.cs.
◆ BrokerageData
| Dictionary<string, string> QuantConnect.Packets.LiveNodePacket.BrokerageData = new Dictionary<string, string>() |
String-String Dictionary of Brokerage Data for this Live Job
Definition at line 41 of file LiveNodePacket.cs.
◆ DataQueueHandler
| string QuantConnect.Packets.LiveNodePacket.DataQueueHandler = "" |
String name of the DataQueueHandler or LiveDataProvider we're running with
Definition at line 46 of file LiveNodePacket.cs.
◆ DataChannelProvider
| string QuantConnect.Packets.LiveNodePacket.DataChannelProvider = "" |
String name of the DataChannelProvider we're running with
Definition at line 51 of file LiveNodePacket.cs.
◆ DisableAcknowledgement
| bool QuantConnect.Packets.LiveNodePacket.DisableAcknowledgement |
Gets flag indicating whether or not the message should be acknowledged and removed from the queue
Definition at line 56 of file LiveNodePacket.cs.
◆ NotificationEvents
| HashSet<string> QuantConnect.Packets.LiveNodePacket.NotificationEvents |
A list of event types to generate notifications for, which will use NotificationTargets
Definition at line 61 of file LiveNodePacket.cs.
◆ NotificationTargets
| List<Notification> QuantConnect.Packets.LiveNodePacket.NotificationTargets |
A list of notification targets to use
Definition at line 66 of file LiveNodePacket.cs.
◆ LiveDataTypes
| HashSet<string> QuantConnect.Packets.LiveNodePacket.LiveDataTypes |
List of real time data types available in the live trading environment
Definition at line 71 of file LiveNodePacket.cs.
Property Documentation
◆ AlgorithmMode
|
get |
Algorithm running mode.
Definition at line 78 of file LiveNodePacket.cs.
The documentation for this class was generated from the following file:
- Common/Packets/LiveNodePacket.cs
