◆ DataUpdateService()
| FiftyOne.Pipeline.Engines.Services.DataUpdateService.DataUpdateService | ( | ILogger< DataUpdateService > | logger, |
| HttpClient | httpClient | ||
| ) |
Constructor
- Parameters
-
- logger - The logger to use
- httpClient - The HttpClient to use when requesting an update from a URL. Note that only one HttpClient instance should be used throughout the application, as described in the documentation: https://msdn.microsoft.com/library/system.net.http.httpclient(v=vs.110).aspx
Member Function Documentation
◆ CheckForUpdate()
AutoUpdateStatus FiftyOne.Pipeline.Engines.Services.DataUpdateService.CheckForUpdate ( IOnPremiseAspectEngine engine, string dataFileIdentifier = null) Check if there are updates for the specified engine.
- Parameters
-
- engine - The engine to check for
- dataFileIdentifier - The identifier of the data file to check for. If the engine has only one data file then this parameter is ignored.
- Returns
- The result of the update check.
- Exceptions
-
- DataUpdateException - Thrown if some problem occurs during the update process.
- ArgumentNullException - Thrown if the parameter is null
Implements FiftyOne.Pipeline.Engines.Services.IDataUpdateService.
◆ RegisterDataFile()
void FiftyOne.Pipeline.Engines.Services.DataUpdateService.RegisterDataFile ( AspectEngineDataFile dataFile ) Register an data file for automatic updates.
- Parameters
-
- dataFile - The details of the data file to register.
Implements FiftyOne.Pipeline.Engines.Services.IDataUpdateService.
◆ UnRegisterDataFile()
void FiftyOne.Pipeline.Engines.Services.DataUpdateService.UnRegisterDataFile ( AspectEngineDataFile dataFile ) Unregister a data file.
- Parameters
-
- dataFile - The data file to unregister
Implements FiftyOne.Pipeline.Engines.Services.IDataUpdateService.
◆ UpdateFromMemory()
AutoUpdateStatus FiftyOne.Pipeline.Engines.Services.DataUpdateService.UpdateFromMemory ( AspectEngineDataFile dataFile, MemoryStream data ) Update the specified data file from a MemoryStream
- Parameters
-
- dataFile - The data file to update.
- data - The data to update with.
- Exceptions
-
- DataUpdateException - Thrown if some problem occurs during the update process.
- ArgumentNullException - Thrown if arguments are null.
Implements FiftyOne.Pipeline.Engines.Services.IDataUpdateService.
Event Documentation
◆ CheckForUpdateComplete
EventHandler<DataUpdateCompleteArgs> FiftyOne.Pipeline.Engines.Services.DataUpdateService.CheckForUpdateComplete The event handler fired when a call to CheckForUpdate is completed.
◆ CheckForUpdateStarted
EventHandler<DataUpdateEventArgs> FiftyOne.Pipeline.Engines.Services.DataUpdateService.CheckForUpdateStarted The event handler fired when a call to CheckForUpdate is started.