HCE Project Python language Distributed Tasks Manager Application, Distributed Crawler Application and client API bindings.  2.0.0-chaika
Hierarchical Cluster Engine Python language binding
dtm.EventObjects.EEResponseData Class Reference

EEResponseData event object, store task results data, returned from EE. More...

Inheritance diagram for dtm.EventObjects.EEResponseData:
Collaboration diagram for dtm.EventObjects.EEResponseData:

Public Member Functions

def __init__ (self, taskId)
 constructor initialize response data fields More...
 
def toJSON (self)
 
def setFile (self, fileItem)
 Set the file item. More...
 

Public Attributes

 id
 The task Id. More...
 
 type
 The request type. More...
 
 errorCode
 The EE response errorCode. More...
 
 errorMessage
 The EE response error message. More...
 
 requestTime
 The EE request time. More...
 
 state
 The task state. More...
 
 pId
 The task process Id in EE. More...
 
 stdout
 The task process stdout. More...
 
 stderr
 The task process stderr. More...
 
 exitStatus
 The task process exit status. More...
 
 taskTime
 The task execution time. More...
 
 nodeName
 The task executor HCE node name in EE. More...
 
 nodeHost
 The task executor HCE node host name. More...
 
 nodePort
 The task executor HCE node port. More...
 
 files
 The files list attached to the task. More...
 
 fields
 The fields dict. More...
 

Static Public Attributes

int ERROR_CODE_TIMEOUT = -1
 
int ERROR_CODE_OK = 0
 
int ERROR_CODE_TASK_NOT_FOUND = 3
 
int ERROR_CODE_BAD_ID = 14
 
string ERROR_MESSAGE_OK = ""
 
string ERROR_MESSAGE_TIMEOUT = "Request timeout reached!"
 
string ERROR_MESSAGE_TASK_NOT_FOUND = "Task not found in queue!"
 
int REQUEST_TYPE_SET = 0
 
int REQUEST_TYPE_CHECK = 1
 
int REQUEST_TYPE_DELETE = 2
 
int REQUEST_TYPE_GET = 3
 
int TASK_STATE_FINISHED = 0
 
int TASK_STATE_IN_PROGRESS = 1
 
int TASK_STATE_NEW = 2
 
int TASK_STATE_NOT_FOUND = 3
 
int TASK_STATE_TERMINATED = 4
 
int TASK_STATE_CRASHED = 5
 
int TASK_STATE_SET_ERROR = 6
 
int TASK_STATE_UNDEFINED = 7
 
int TASK_STATE_TERMINATED_BY_DRCE_TTL = 11
 
int TASK_STATE_SCHEDULED_TO_DELETE = 100
 
int TASK_STATE_DELETED = 101
 
int TASK_STATE_NEW_DATA_STORED = 102
 
int TASK_STATE_NEW_SCHEDULED = 103
 
int TASK_STATE_CLEANED = 104
 
int TASK_STATE_NEW_JUST_CREATED = 105
 
int TASK_STATE_SCHEDULE_TRIES_EXCEEDED = 106
 
int TASK_STATE_RUN_TRIES_EXCEEDED = 107
 

Detailed Description

EEResponseData event object, store task results data, returned from EE.

The EEResponseData object used to represent tasks results data.

Definition at line 653 of file EventObjects.py.

Constructor & Destructor Documentation

◆ __init__()

def dtm.EventObjects.EEResponseData.__init__ (   self,
  taskId 
)

constructor initialize response data fields

Parameters
idtask id.

Definition at line 694 of file EventObjects.py.

694  def __init__(self, taskId):
695 
697  self.id = taskId
698 
700  self.type = self.REQUEST_TYPE_SET
701 
703  self.errorCode = self.ERROR_CODE_OK
704 
706  self.errorMessage = self.ERROR_MESSAGE_OK
707 
709  self.requestTime = 0
710 
712  self.state = self.TASK_STATE_FINISHED
713 
715  self.pId = 0
716 
718  self.stdout = ""
719 
721  self.stderr = ""
722 
724  self.exitStatus = 0
725 
727  self.taskTime = 0
728 
730  self.nodeName = ""
731 
733  self.nodeHost = ""
734 
736  self.nodePort = 0
737 
739  self.files = []
740 
742  self.fields = {}
743 
def __init__(self)
constructor
Definition: UIDGenerator.py:19

Member Function Documentation

◆ setFile()

def dtm.EventObjects.EEResponseData.setFile (   self,
  fileItem 
)

Set the file item.

Appends file item to files container

Parameters
fileItemThe file item for files container, format (fileName, byteStream, actionMask).
Returns
nothing

Definition at line 752 of file EventObjects.py.

752  def setFile(self, fileItem):
753  self.files.append(fileItem)
754 
755 
756 

◆ toJSON()

def dtm.EventObjects.EEResponseData.toJSON (   self)

Definition at line 744 of file EventObjects.py.

744  def toJSON(self):
745  return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True, indent=4)
746 
747 

Member Data Documentation

◆ ERROR_CODE_BAD_ID

int dtm.EventObjects.EEResponseData.ERROR_CODE_BAD_ID = 14
static

Definition at line 660 of file EventObjects.py.

◆ ERROR_CODE_OK

int dtm.EventObjects.EEResponseData.ERROR_CODE_OK = 0
static

Definition at line 657 of file EventObjects.py.

◆ ERROR_CODE_TASK_NOT_FOUND

int dtm.EventObjects.EEResponseData.ERROR_CODE_TASK_NOT_FOUND = 3
static

Definition at line 659 of file EventObjects.py.

◆ ERROR_CODE_TIMEOUT

int dtm.EventObjects.EEResponseData.ERROR_CODE_TIMEOUT = -1
static

Definition at line 656 of file EventObjects.py.

◆ ERROR_MESSAGE_OK

string dtm.EventObjects.EEResponseData.ERROR_MESSAGE_OK = ""
static

Definition at line 663 of file EventObjects.py.

◆ ERROR_MESSAGE_TASK_NOT_FOUND

string dtm.EventObjects.EEResponseData.ERROR_MESSAGE_TASK_NOT_FOUND = "Task not found in queue!"
static

Definition at line 665 of file EventObjects.py.

◆ ERROR_MESSAGE_TIMEOUT

string dtm.EventObjects.EEResponseData.ERROR_MESSAGE_TIMEOUT = "Request timeout reached!"
static

Definition at line 664 of file EventObjects.py.

◆ errorCode

dtm.EventObjects.EEResponseData.errorCode

The EE response errorCode.

Definition at line 703 of file EventObjects.py.

◆ errorMessage

dtm.EventObjects.EEResponseData.errorMessage

The EE response error message.

Definition at line 706 of file EventObjects.py.

◆ exitStatus

dtm.EventObjects.EEResponseData.exitStatus

The task process exit status.

Definition at line 724 of file EventObjects.py.

◆ fields

dtm.EventObjects.EEResponseData.fields

The fields dict.

Definition at line 742 of file EventObjects.py.

◆ files

dtm.EventObjects.EEResponseData.files

The files list attached to the task.

Format of items the same as in NewTask object.

Definition at line 739 of file EventObjects.py.

◆ id

dtm.EventObjects.EEResponseData.id

The task Id.

Definition at line 697 of file EventObjects.py.

◆ nodeHost

dtm.EventObjects.EEResponseData.nodeHost

The task executor HCE node host name.

Definition at line 733 of file EventObjects.py.

◆ nodeName

dtm.EventObjects.EEResponseData.nodeName

The task executor HCE node name in EE.

Definition at line 730 of file EventObjects.py.

◆ nodePort

dtm.EventObjects.EEResponseData.nodePort

The task executor HCE node port.

Definition at line 736 of file EventObjects.py.

◆ pId

dtm.EventObjects.EEResponseData.pId

The task process Id in EE.

Definition at line 715 of file EventObjects.py.

◆ REQUEST_TYPE_CHECK

int dtm.EventObjects.EEResponseData.REQUEST_TYPE_CHECK = 1
static

Definition at line 668 of file EventObjects.py.

◆ REQUEST_TYPE_DELETE

int dtm.EventObjects.EEResponseData.REQUEST_TYPE_DELETE = 2
static

Definition at line 669 of file EventObjects.py.

◆ REQUEST_TYPE_GET

int dtm.EventObjects.EEResponseData.REQUEST_TYPE_GET = 3
static

Definition at line 670 of file EventObjects.py.

◆ REQUEST_TYPE_SET

int dtm.EventObjects.EEResponseData.REQUEST_TYPE_SET = 0
static

Definition at line 667 of file EventObjects.py.

◆ requestTime

dtm.EventObjects.EEResponseData.requestTime

The EE request time.

Definition at line 709 of file EventObjects.py.

◆ state

dtm.EventObjects.EEResponseData.state

The task state.

Definition at line 712 of file EventObjects.py.

◆ stderr

dtm.EventObjects.EEResponseData.stderr

The task process stderr.

Definition at line 721 of file EventObjects.py.

◆ stdout

dtm.EventObjects.EEResponseData.stdout

The task process stdout.

Definition at line 718 of file EventObjects.py.

◆ TASK_STATE_CLEANED

int dtm.EventObjects.EEResponseData.TASK_STATE_CLEANED = 104
static

Definition at line 685 of file EventObjects.py.

◆ TASK_STATE_CRASHED

int dtm.EventObjects.EEResponseData.TASK_STATE_CRASHED = 5
static

Definition at line 677 of file EventObjects.py.

◆ TASK_STATE_DELETED

int dtm.EventObjects.EEResponseData.TASK_STATE_DELETED = 101
static

Definition at line 682 of file EventObjects.py.

◆ TASK_STATE_FINISHED

int dtm.EventObjects.EEResponseData.TASK_STATE_FINISHED = 0
static

Definition at line 672 of file EventObjects.py.

◆ TASK_STATE_IN_PROGRESS

int dtm.EventObjects.EEResponseData.TASK_STATE_IN_PROGRESS = 1
static

Definition at line 673 of file EventObjects.py.

◆ TASK_STATE_NEW

int dtm.EventObjects.EEResponseData.TASK_STATE_NEW = 2
static

Definition at line 674 of file EventObjects.py.

◆ TASK_STATE_NEW_DATA_STORED

int dtm.EventObjects.EEResponseData.TASK_STATE_NEW_DATA_STORED = 102
static

Definition at line 683 of file EventObjects.py.

◆ TASK_STATE_NEW_JUST_CREATED

int dtm.EventObjects.EEResponseData.TASK_STATE_NEW_JUST_CREATED = 105
static

Definition at line 686 of file EventObjects.py.

◆ TASK_STATE_NEW_SCHEDULED

int dtm.EventObjects.EEResponseData.TASK_STATE_NEW_SCHEDULED = 103
static

Definition at line 684 of file EventObjects.py.

◆ TASK_STATE_NOT_FOUND

int dtm.EventObjects.EEResponseData.TASK_STATE_NOT_FOUND = 3
static

Definition at line 675 of file EventObjects.py.

◆ TASK_STATE_RUN_TRIES_EXCEEDED

int dtm.EventObjects.EEResponseData.TASK_STATE_RUN_TRIES_EXCEEDED = 107
static

Definition at line 688 of file EventObjects.py.

◆ TASK_STATE_SCHEDULE_TRIES_EXCEEDED

int dtm.EventObjects.EEResponseData.TASK_STATE_SCHEDULE_TRIES_EXCEEDED = 106
static

Definition at line 687 of file EventObjects.py.

◆ TASK_STATE_SCHEDULED_TO_DELETE

int dtm.EventObjects.EEResponseData.TASK_STATE_SCHEDULED_TO_DELETE = 100
static

Definition at line 681 of file EventObjects.py.

◆ TASK_STATE_SET_ERROR

int dtm.EventObjects.EEResponseData.TASK_STATE_SET_ERROR = 6
static

Definition at line 678 of file EventObjects.py.

◆ TASK_STATE_TERMINATED

int dtm.EventObjects.EEResponseData.TASK_STATE_TERMINATED = 4
static

Definition at line 676 of file EventObjects.py.

◆ TASK_STATE_TERMINATED_BY_DRCE_TTL

int dtm.EventObjects.EEResponseData.TASK_STATE_TERMINATED_BY_DRCE_TTL = 11
static

Definition at line 680 of file EventObjects.py.

◆ TASK_STATE_UNDEFINED

int dtm.EventObjects.EEResponseData.TASK_STATE_UNDEFINED = 7
static

Definition at line 679 of file EventObjects.py.

◆ taskTime

dtm.EventObjects.EEResponseData.taskTime

The task execution time.

Definition at line 727 of file EventObjects.py.

◆ type

dtm.EventObjects.EEResponseData.type

The request type.

Definition at line 700 of file EventObjects.py.


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