Detailed Description
Builder interface specific to AspectEngines.
Public Member Functions | |
| AspectEngineBuilder | setProperties (List< String > properties) |
| Set a list of properties to be included in the results of its processing. | |
| AspectEngineBuilder | setProperty (String property) |
| Set a property to be included in the results of its processing. | |
| AspectEngineBuilder | setProperties (Set< AspectPropertyMetaData > properties) |
| Set a list of properties to be included in the results of its processing. | |
| AspectEngineBuilder | setProperty (AspectPropertyMetaData property) |
| Set a property to be included in the results of its processing. | |
| AspectEngineBuilder | setCache (CacheConfiguration config) |
| Set the cache that the engine should use to cache its results. | |
| AspectEngineBuilder | setPollingInterval (int interval) |
Set the interval in milliseconds at which the file on disk is checked for changes by the DataUpdateService. | |
| AspectEngineBuilder | setUpdateTimeRandomisation (int maxRandomisation) |
Set the maximum time in milliseconds for the DataUpdateService to add to scheduled update times for this Engine. | |
| AspectEngineBuilder | setUpdateUrl (String url) |
| Override the Engine's default data update URL. | |
| AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > | build (@BuildArg("dataFile") String dataFile) |
Build the AspectEngine that has been defined in this instance of AspectEngineBuilder using the data file provided. | |
| AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > | build (byte[] data) |
Build the AspectEngine that has been defined in this instance of AspectEngineBuilder using the data provided. | |
Member Function Documentation
◆ build() [1/2]
| AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.build | ( | @BuildArg("dataFile") String | dataFile | ) |
Build the AspectEngine that has been defined in this instance of AspectEngineBuilder using the data file provided.
- Parameters
-
dataFile path to the file to be used
- Returns
- constructed
AspectEngine
◆ build() [2/2]
| AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.build | ( | byte[] | data | ) |
Build the AspectEngine that has been defined in this instance of AspectEngineBuilder using the data provided.
- Parameters
-
data in memory data to be used
- Returns
- constructed
AspectEngine
◆ setCache()
| AspectEngineBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.setCache | ( | CacheConfiguration | config | ) |
Set the cache that the engine should use to cache its results.
This is a cache configuration which is the build inside the engine to ensure it is immutable. This is used cache AspectData keyed on the evidence in FlowData, so should be configured to construct a key using only the relevant pieces of evidence.
- Parameters
-
config of cache to create
- Returns
- this builder
◆ setPollingInterval()
| AspectEngineBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.setPollingInterval | ( | int | interval | ) |
Set the interval in milliseconds at which the file on disk is checked for changes by the DataUpdateService.
By default this is 30 minutes.
- Parameters
-
interval check interval in ms
- Returns
- this builder
◆ setProperties() [1/2]
| AspectEngineBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.setProperties | ( | List< String > | properties | ) |
Set a list of properties to be included in the results of its processing.
If none are set, then all properties are included.
- Parameters
-
properties names of properties to include in results
- Returns
- this builder
◆ setProperties() [2/2]
| AspectEngineBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.setProperties | ( | Set< AspectPropertyMetaData > | properties | ) |
Set a list of properties to be included in the results of its processing.
If none are set, then all properties are included.
- Parameters
-
properties to include in results
- Returns
- this builder
◆ setProperty() [1/2]
| AspectEngineBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.setProperty | ( | AspectPropertyMetaData | property | ) |
Set a property to be included in the results of its processing.
If none are set, then all properties are included.
- Parameters
-
property to include in results
- Returns
- this builder
◆ setProperty() [2/2]
| AspectEngineBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.setProperty | ( | String | property | ) |
Set a property to be included in the results of its processing.
If none are set, then all properties are included.
- Parameters
-
property name of property to include in results
- Returns
- this builder
◆ setUpdateTimeRandomisation()
| AspectEngineBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.setUpdateTimeRandomisation | ( | int | maxRandomisation | ) |
Set the maximum time in milliseconds for the DataUpdateService to add to scheduled update times for this Engine.
Scheduling an update for a random time within a defined window avoids the possibility of many machines updating at the same time. By default this is 10 minutes.
- Parameters
-
maxRandomisation max update randomisation in ms
- Returns
- this builder
◆ setUpdateUrl()
| AspectEngineBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilder.setUpdateUrl | ( | String | url | ) |
Override the Engine's default data update URL.
This must contain the entire URL string needed including any license keys and other parameters as this completely overrides any URL generation performed by the Engine.
- Parameters
-
url full URL to use for data updates
- Returns
- this builder
