IasCmdReply.IasCommand
index
/home/fedora/IasRoot/lib/python3.12/site-packages/IasCmdReply/IasCommand.py

Created on Dec 16, 2019
 
@author: acaproni

 
Modules
       
json

 
Classes
       
builtins.object
IasCommand

 
class IasCommand(builtins.object)
    IasCommand(dest: str, sender: str, cmd, id: int, tStamp: str, params=None, props=None)
 
The python data structure for a Command to be sent to the kafka command topic.
 
It is the python equivalent of the java org.eso.ias.command.CommandMessage
 
All parameters are strings, the timestamps are string formatted as ISO-8601
 
  Methods defined here:
__init__(self, dest: str, sender: str, cmd, id: int, tStamp: str, params=None, props=None)
Constructor
 
Build a command with the given parameters
 
Params:
    dest The ID of destination (or BROADCAST)
    sender The full running id of the sender (string)
    cmd The command to execute (a string or a IasCommandType)
    id The unique identifier of the command (int or string encoding an int)
    tStamp The timestamp when the command has been published (in ISO 8601 format)
    params The parameters of the command, if any (Nore or list of strings)
    props Additional properties, if any (None or dictionary of strings)
toJSonString(self)
@return the JSON representation of the IasCommand

Static methods defined here:
fromJSon(jsonStr)
Factory method to build a IasCommand from a JSON string
 
@param jsonStr the json string representing the IasCommand

Data descriptors defined here:
__dict__
dictionary for instance variables
__weakref__
list of weak references to the object

Data and other attributes defined here:
BROADCAST_ADDRESS = '*'
__annotations__ = {'command': <enum 'IasCommandType'>, 'id': <class 'int'>}
command = None
destId = None
id = None
params = None
props = None
senderFullRunningId = None
timestamp = None