◆ FiftyOneDataFile()
FiftyOne.Pipeline.Engines.FiftyOne.Data.FiftyOneDataFile.FiftyOneDataFile | ( | Type | engineType | ) |
Constructor
- Parameters
-
- engineType -
\r\n
Class that stores meta-data relating to a data file associated with a 51Degrees engine.
FiftyOneDataFile (Type engineType)
Constructor More...
| |
Public Member Functions inherited from FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile | |
AspectEngineDataFile (Type engineType=null)
Constructor More...
| |
void | SetDataUpdateService (IDataUpdateService dataUpdateService)
Set the data update service that this data file is registered with. More...
|
void | Dispose ()
Dispose of this instance's resources. More...
|
string?? | DataDownloadType [get, set]
Get the type name to send when checking for data file updates. More...
|
Properties inherited from FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile | |
string?? | Identifier [get, set]
The name or identifier for this data file object. More...
|
IOnPremiseAspectEngine | Engine [get, set]
Get or set the IOnPremiseAspectEngine associated with this data file. More...
|
Type | EngineType [get]
Get or set the type of the engine that this data file is for. More...
|
virtual string | DataFilePath [get]
The complete file path to the location of the data file. More...
|
string | TempDataDirPath [get, set]
The path to use when working with temporary files associated with this data file. More...
|
virtual bool | AutomaticUpdatesEnabled [get]
True if automatic updates are enabled, false otherwise. More...
|
virtual string | TempDataFilePath [get, set]
The complete file path to the location of the temporary copy of the data file that is currently being used by the IAspectEngine. More...
|
DateTime | UpdateAvailableTime [get, set]
The date/time that a data update is expected to be available. More...
|
DateTime | DataPublishedDateTime [get, set]
The data/time that this data was published. More...
|
IDataFileConfiguration | Configuration [get, set]
The configuration parameters used when creating this data file instance. More...
|
virtual Uri | FormattedUri [get]
Get the data update URL complete with any query string parameters that are needed to retrieve the data. More...
|
bool | IsRegistered [get]
Returns true if this file has been registered with the data update service. More...
|
Properties inherited from FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile | |
string | Identifier [get, set]
An identifier for this data file. More...
|
IOnPremiseAspectEngine | Engine [get, set]
The engine this data file is used by More...
|
Type | EngineType [get]
Get the type of the engine that this data file is for. More...
|
string | DataFilePath [get]
The complete file path to the location of the data file. More...
|
string | TempDataDirPath [get, set]
The path to use when working with temporary files associated with this data file. More...
|
string | TempDataFilePath [get, set]
The complete file path to the location of the temporary copy of the data file that is currently being used by the IAspectEngine. More...
|
bool | AutomaticUpdatesEnabled [get]
True if automatic updates are enabled, false otherwise. More...
|
DateTime | UpdateAvailableTime [get, set]
The date and time by which an update to the current data file is expected to have been published. More...
|
DateTime | DataPublishedDateTime [get, set]
The date and time that the current data file was published. More...
|
IDataFileConfiguration | Configuration [get, set]
The configuration that was provided for this data file. More...
|
string | FormattedUrl [get]
Get the data update URL complete with any query string parameters that are needed to retrieve the data. More...
|
Uri | FormattedUri [get]
Get the data update URL complete with any query string parameters that are needed to retrieve the data. More...
|
bool | IsRegistered [get]
Returns true if this file has been registered with the data update service. More...
|
Properties inherited from FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneDataFile | |
string | DataDownloadType [get, set]
The value for the 'type' parameter that is passed to the distributor service when checking for a new file. More...
|
FiftyOne.Pipeline.Engines.FiftyOne.Data.FiftyOneDataFile.FiftyOneDataFile | ( | Type | engineType | ) |
Constructor
string?? FiftyOne.Pipeline.Engines.FiftyOne.Data.FiftyOneDataFile.DataDownloadType |
Get the type name to send when checking for data file updates.
In general, this value should be pulled from the Engine, which will have read it from the data file. However, in some cases, we want to know the type name before the engine is created. (e.g. when UpdateOnStartup is set) This is why the value can also be set.