\r\n

51Degrees Pipeline Python  4.2

51Degrees Pipeline for Python
  • pipeline-python
  • fiftyone_pipeline_cloudrequestengine
  • fiftyone_pipeline_cloudrequestengine
  • cloudrequestengine
  • CloudRequestEngine

pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine Class Reference

Inheritance diagram for pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine:

[legend]

Collaboration diagram for pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine:

[legend]

Public Member Functions

def  __init__ (self, settings={})
Constructor for CloudRequestEngine. More...
def  get_evidence_keys (self)
Internal function for getting evidence keys used by cloud engines @rtype: dict. More...
def  get_evidence_key_filter (self)
Instance of EvidenceKeyFilter based on the evidence keys fetched from the cloud service by the private getEvidenceKeys() method. More...
def  get_engine_properties (self)
Internal method to get properties for cloud engines from the cloud service. More...
def  make_cloud_request (self, url)
@type url: string More...
def  process_internal (self, flowdata)
Processing function for the CloudRequestEngine Makes a request to the cloud service with the supplied resource key and evidence and returns a JSON object that is then parsed by cloud engines placed later in the pipeline. More...

Public Attributes

 datakey
 properties
 resource_key
 baseURL
 http_client
 flow_element_properties
 evidence_keys
 exclude_from_messages

Constructor & Destructor Documentation

◆ __init__()

def pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine.__init__ (   self,
  settings = {}  
)

Constructor for CloudRequestEngine.

@type settings: dict

Parameters
settings - Settings should contain a resource_key and optionally a cloud_endpoint to overwrite the default baseurl

Member Function Documentation

◆ get_engine_properties()

def pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine.get_engine_properties (   self )

Internal method to get properties for cloud engines from the cloud service.

@rtype: dict

Returns
: Returns properties for all engines

◆ get_evidence_key_filter()

def pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine.get_evidence_key_filter (   self )

Instance of EvidenceKeyFilter based on the evidence keys fetched from the cloud service by the private getEvidenceKeys() method.

@type: BasicListEvidenceKeyFilter

Returns
: Returns BasicListEvidenceKeyFilter

◆ get_evidence_keys()

def pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine.get_evidence_keys (   self )

Internal function for getting evidence keys used by cloud engines @rtype: dict.

Returns
: Returns list of keys

◆ make_cloud_request()

def pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine.make_cloud_request (   self,
  url  
)

@type url: string

Parameters
url - @rtype: dict
Returns
Returns dict with data and error properties error contains any errors from the request, data contains the response

◆ process_internal()

def pipeline-python.fiftyone_pipeline_cloudrequestengine.fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine.process_internal (   self,
  flowdata  
)

Processing function for the CloudRequestEngine Makes a request to the cloud service with the supplied resource key and evidence and returns a JSON object that is then parsed by cloud engines placed later in the pipeline.

@type FlowData: FlowData

Parameters
FlowData - Returns a JSON object that is then parsed by cloud engines