qcg.pilotjob.request module

class qcg.pilotjob.request.Request

Bases: object

Base class for all requests.

Each sub-class should have defined methods:
to_dict() - serialize request to dictionary to_json() - serialize request to JSON format
and class attribute:
REQ_NAME - name of the request
classmethod parse(data)

Parse request.

Parameters:data (dict) – parsed data
Returns:request object
Return type:req (Request)
Raises:InvalidRequest – in case of wrong or unknown request
class qcg.pilotjob.request.ControlReq(data)

Bases: qcg.pilotjob.request.Request

The control request.

command

the control command

Type:str

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'control'
REQ_CONTROL_CMD_FINISHAFTERALLTASKSDONE = 'finishAfterAllTasksDone'
REQ_CONTROL_CMDS = ['finishAfterAllTasksDone']
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.RegisterReq(data)

Bases: qcg.pilotjob.request.Request

The register request.

entity

the register entity

Type:str
params

register parameters, the required keys are id, address and resources

Type:dict

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'register'
REQ_REGISTER_ENTITIES = ['manager']
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.SubmitReq(data)

Bases: qcg.pilotjob.request.Request

The submit request.

jobs

the list of job descriptions

Type:list(dict)

Initialize request.

Parameters:data (dict) – request data
Raises:InvalidRequest – in case of wrong job description format
REQ_NAME = 'submit'
REQ_CNT = 1
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.JobStatusReq(data)

Bases: qcg.pilotjob.request.Request

The job status request.

job_names

the job names list to report status

Type:list(str)

Initialize request.

Parameters:data (dict) – request data
Raises:InvalidRequest – in case of wrong request format
REQ_NAME = 'jobStatus'
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.JobInfoReq(data)

Bases: qcg.pilotjob.request.Request

The job info request.

job_names

the job names list to report info

Type:list(str)
include_childs

does the job’s iteration also should be reported

Type:bool

Initialize request.

Parameters:data (dict) – request data
Raises:InvalidRequest – in case of wrong request format
REQ_NAME = 'jobInfo'
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.CancelJobReq(data)

Bases: qcg.pilotjob.request.Request

The cancel job request.

Currently not supported.

job_names

job names to cancel

Type:list(str)

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'cancelJob'
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.RemoveJobReq(data)

Bases: qcg.pilotjob.request.Request

Remove job from system.

job_names

job names to remove

Type:str

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'removeJob'
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.ListJobsReq(data)

Bases: qcg.pilotjob.request.Request

The list jobs request.

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'listJobs'
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.ResourcesInfoReq(data)

Bases: qcg.pilotjob.request.Request

The resources info request.

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'resourcesInfo'
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.FinishReq(data)

Bases: qcg.pilotjob.request.Request

The finish request.

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'finish'
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.StatusReq(data)

Bases: qcg.pilotjob.request.Request

The current statistics request.

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'status'
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str
class qcg.pilotjob.request.NotifyReq(data)

Bases: qcg.pilotjob.request.Request

The notify request.

entity

the notify entity

Type:str
params

notify parameters, the required keys are name, state and attributes

Type:dict

Initialize request.

Parameters:data (dict) – request data
REQ_NAME = 'notify'
NOTIFY_ENTITY = ['job']
to_dict()

Serialize request to dictionary.

Returns:serialized request
Return type:dict
to_json()

Serialize request to JSON format.

Returns:serialized request
Return type:str