\r\n

51Degrees Pipeline Python  4.3

51Degrees Pipeline for Python
  • pipeline-python
  • fiftyone_pipeline_engines
  • fiftyone_pipeline_engines
  • datafile_update_service
  • DataFileUpdateService

pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.datafile_update_service.DataFileUpdateService Class Reference

Detailed Description

A data file update service is attached to a pipeline and manages the download of datafiles used by engines.

Public Member Functions

def  __init__ (self, pipeline)
Constructor for the DataFileUpdateService @type pipeline: Pipeline. More...
def  update_data_file (self, data_file)
Function to request, download, check and unzip a datafile from an update service via an HTTP request @type data_file: DataFile. More...
def  async_update_data_file (self, data_file)
Non blocking version of update_data_file @type data_file: DataFile. More...
def  check_next_update (self, data_file)
Function to periodically check if a datafile needs updating also updates the datafile on start if it is set with the update_on_start option @type data_file: DataFile. More...
def  register_data_file (self, data_file)
Function to register a datafile with the update service @type data_file: DataFile. More...
def  track_local_data_file_changes (self, data_file)
Check for local changes to a datafile. More...

Public Attributes

 pipeline

Constructor & Destructor Documentation

◆ __init__()

def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.datafile_update_service.DataFileUpdateService.__init__ (   self,
  pipeline  
)

Constructor for the DataFileUpdateService @type pipeline: Pipeline.

Parameters
pipeline - The pipeline the datafile update service is attached to

Member Function Documentation

◆ async_update_data_file()

def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.datafile_update_service.DataFileUpdateService.async_update_data_file (   self,
  data_file  
)

Non blocking version of update_data_file @type data_file: DataFile.

Parameters
data_file - Datafile to update

◆ check_next_update()

def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.datafile_update_service.DataFileUpdateService.check_next_update (   self,
  data_file  
)

Function to periodically check if a datafile needs updating also updates the datafile on start if it is set with the update_on_start option @type data_file: DataFile.

Parameters
data_file - Datafile to check updates for

◆ register_data_file()

def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.datafile_update_service.DataFileUpdateService.register_data_file (   self,
  data_file  
)

Function to register a datafile with the update service @type data_file: DataFile.

Parameters
data_file - Datafile to check updates for

◆ track_local_data_file_changes()

def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.datafile_update_service.DataFileUpdateService.track_local_data_file_changes (   self,
  data_file  
)

Check for local changes to a datafile.

Used by the file system watcher @type data_file: DataFile

Parameters
data_file - Datafile to check updates for

◆ update_data_file()

def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.datafile_update_service.DataFileUpdateService.update_data_file (   self,
  data_file  
)

Function to request, download, check and unzip a datafile from an update service via an HTTP request @type data_file: DataFile.

Parameters
data_file - Datafile to update