◆ DataFileConfigurationBuilderBase()
FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.DataFileConfigurationBuilderBase | ( | ) |
Constructor
\r\n
Builder class that is used to create instances of DataFileConfiguration objects.
TBuilder | : | DataFileConfigurationBuilderBase | |
TBuilder | : | TBuilder | |
TBuilder | : | TConfig | |
TConfig | : | DataFileConfiguration | |
TConfig | : | new() |
DataFileConfigurationBuilderBase ()
Constructor More...
| |
TBuilder | SetDataFileIdentifier (string identifier)
Set the identifier of the data file that this configuration information applies to. More...
|
TBuilder | SetDataUpdateUrl (string url)
Configure the engine to use the specified URL when looking for an updated data file. More...
|
TBuilder | SetDataUpdateUrl (Uri url)
Configure the engine to use the specified URL when looking for an updated data file. More...
|
TBuilder | SetDataUpdateUrlFormatter (IDataUpdateUrlFormatter formatter)
Specify a IDataUpdateUrlFormatter to be used by the DataUpdateService when building the complete URL to query for updated data. More...
|
TBuilder | SetDataUpdateVerifyMd5 (bool verify)
Set a value indicating if the DataUpdateService should expect the response from the data update URL to contain a 'content-md5' HTTP header that can be used to verify the integrity of the content. More...
|
TBuilder | SetDataUpdateDecompress (bool decompress)
Set a value indicating if the DataUpdateService should expect content from the configured data update URL to be compressed or not. More...
|
TBuilder | SetAutoUpdate (bool enabled)
Enable or disable automatic updates for this engine. More...
|
TBuilder | SetDataFileSystemWatcher (bool enabled)
The DataUpdateService has the ability to watch a data file on disk and automatically refresh the engine as soon as the file is updated. More...
|
TBuilder | SetUpdatePollingInterval (int pollingIntervalSeconds)
Set the time between checks for a new data file made by the DataUpdateService. More...
|
TBuilder | SetUpdatePollingInterval (TimeSpan pollingInterval)
Set the time between checks for a new data file made by the DataUpdateService. More...
|
TBuilder | SetUpdateRandomisationMax (int maximumDeviationSeconds)
A random element can be added to the DataUpdateService polling interval. More...
|
TBuilder | SetUpdateRandomisationMax (TimeSpan maximumDeviation)
A random element can be added to the DataUpdateService polling interval. More...
|
TBuilder | SetVerifyIfModifiedSince (bool enabled)
Set if DataUpdateService sends the If-Modified-Since header in the request for a new data file. More...
|
TBuilder | SetDataUpdateLicenseKey (string key)
Set the license key to use when updating the Engine's data file. More...
|
TBuilder | SetDataUpdateLicenseKeys (string[] keys)
Set the license keys to use when updating the Engine's data file. More...
|
TBuilder | SetUpdateOnStartup (bool enabled)
Configure the data file to update on startup or not. More...
|
TConfig | Build (string filename, bool createTempCopy)
Called to indicate that configuration of this file is complete and the user can continue to configure the engine that the data file will be used by. More...
|
TConfig | Build (Stream data)
Called to indicate that configuration of this file is complete and the user can continue to configure the engine that the data file will be used by. More...
|
List< string > | DataUpdateLicenseKeys = new List<string>() [get]
License keys to use when updating the Engine's data file. More...
|
FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.DataFileConfigurationBuilderBase | ( | ) |
Constructor
TConfig FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.Build | ( | string | filename, |
bool | createTempCopy | ||
) |
Called to indicate that configuration of this file is complete and the user can continue to configure the engine that the data file will be used by.
TConfig FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.Build | ( | Stream | data | ) |
Called to indicate that configuration of this file is complete and the user can continue to configure the engine that the data file will be used by.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetAutoUpdate | ( | bool | enabled | ) |
Enable or disable automatic updates for this engine.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataFileIdentifier | ( | string | identifier | ) |
Set the identifier of the data file that this configuration information applies to.
If the engine only supports a single data file then this value will be ignored.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataFileSystemWatcher | ( | bool | enabled | ) |
The DataUpdateService has the ability to watch a data file on disk and automatically refresh the engine as soon as the file is updated.
This setting enables/disables that feature.
The AutoUpdate feature must also be enabled in order for the file system watcher to work. If the engine is built from a byte[] then this setting does nothing.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataUpdateDecompress | ( | bool | decompress | ) |
Set a value indicating if the DataUpdateService should expect content from the configured data update URL to be compressed or not.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataUpdateLicenseKey | ( | string | key | ) |
Set the license key to use when updating the Engine's data file.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataUpdateLicenseKeys | ( | string [] | keys | ) |
Set the license keys to use when updating the Engine's data file.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataUpdateUrl | ( | string | url | ) |
Configure the engine to use the specified URL when looking for an updated data file.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataUpdateUrl | ( | Uri | url | ) |
Configure the engine to use the specified URL when looking for an updated data file.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataUpdateUrlFormatter | ( | IDataUpdateUrlFormatter | formatter | ) |
Specify a IDataUpdateUrlFormatter to be used by the DataUpdateService when building the complete URL to query for updated data.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetDataUpdateVerifyMd5 | ( | bool | verify | ) |
Set a value indicating if the DataUpdateService should expect the response from the data update URL to contain a 'content-md5' HTTP header that can be used to verify the integrity of the content.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetUpdateOnStartup | ( | bool | enabled | ) |
Configure the data file to update on startup or not.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetUpdatePollingInterval | ( | int | pollingIntervalSeconds | ) |
Set the time between checks for a new data file made by the DataUpdateService.
Default = 30 minutes.
Generally, the DataUpdateService will not check for a new data file until the 'expected update time' that is stored in the current data file. This interval is the time to wait between checks after that time if no update is initially found. If automatic updates are disabled then this setting does nothing.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetUpdatePollingInterval | ( | TimeSpan | pollingInterval | ) |
Set the time between checks for a new data file made by the DataUpdateService.
Default = 30 minutes.
Generally, the DataUpdateService will not check for a new data file until the 'expected update time' that is stored in the current data file. This interval is the time to wait between checks after that time if no update is initially found. If automatic updates are disabled then this setting does nothing.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetUpdateRandomisationMax | ( | int | maximumDeviationSeconds | ) |
A random element can be added to the DataUpdateService polling interval.
This option sets the maximum length of this random addition. Default = 10 minutes.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetUpdateRandomisationMax | ( | TimeSpan | maximumDeviation | ) |
A random element can be added to the DataUpdateService polling interval.
This option sets the maximum length of this random addition. Default = 10 minutes.
TBuilder FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.SetVerifyIfModifiedSince | ( | bool | enabled | ) |
Set if DataUpdateService sends the If-Modified-Since header in the request for a new data file.
List<string> FiftyOne.Pipeline.Engines.Configuration.DataFileConfigurationBuilderBase< TBuilder, TConfig >.DataUpdateLicenseKeys = new List<string>() |
License keys to use when updating the Engine's data file.