Inheritance diagram for IpIntelligencePipelineBuilder:
Collaboration diagram for IpIntelligencePipelineBuilder:
Public Member Functions | |
| constructor ({ licenceKeys=null, dataFile=null, autoUpdate=true, fileSystemWatcher=true, pollingInterval=30, updateTimeMaximumRandomisation=10, shareUsage=true, resourceKey=null, requestedProperties=null, cacheSize=null, restrictedProperties, performanceProfile='Balanced', updateOnStart=false, cloudEndPoint=null, cloudRequestOrigin=null }) | |
| Extension of pipelineBuilder class that allows for the quick generation of an IP intelligence pipeline. | |
Public Member Functions inherited from PipelineBuilder | |
| constructor (settings={}) | |
| buildFromConfigurationFile (configPath) | |
| buildFromConfiguration (config) | |
| getSuppressProcessExceptions (config) | |
| addRequiredElements (flowElements) | |
| getSequenceElements () | |
| getJavaScriptElements () | |
| getHttpElements () | |
| add (flowElement) | |
| addParallel (flowElements) | |
| build () | |
Member Function Documentation
◆ constructor()
|
inline |
Extension of pipelineBuilder class that allows for the quick generation of an IP intelligence pipeline.
Adds share usage, caching and toggles between on premise and cloud with simple parameter changes
- Parameters
-
{object} options the options for the pipeline builder {string} options.licenceKeys license key(s) used by the data file update service. A key can be obtained from the 51Degrees website: /pricing?utm_source=code&utm_medium=comment&utm_campaign=51degrees-node&utm_content=fiftyone.ipintelligence-ipintelligencepipelinebuilder.js&utm_term=constructor. This parameter MUST be set when using a data file. If you do not wish to use a key then you can specify an empty string, but this will cause automatic updates to be disabled. {Array<string>|string} options.requestedProperties the fully qualified names of the properties to ask the cloud service for, such as ip.registeredcountry. Required with a license key and no resource key. {string} options.resourceKey resourceKey, if using the cloud engine {string} options.dataFile dataFile path for the on premise engine {boolean} options.autoUpdate whether to autoUpdate the dataFile {number} options.pollingInterval How often to poll for updates to the datafile (minutes) {number} options.updateTimeMaximumRandomisation Maximum randomisation offset in seconds to polling time interval {boolean} options.fileSystemWatcher whether to monitor the datafile path for changes {boolean} options.updateOnStart whether to download / update a dataFile to the path specified in options.dataFile on start {boolean} options.shareUsage whether to include the share usage element {number} options.cacheSize size of the default cache (includes cache if set). NOTE: This is not supported for on-premise engine. {Array} options.restrictedProperties This setting only affects on-premise engines, not cloud. list of properties the engine will be restricted to {string} options.performanceProfile used to control the tradeoff between performance and system memory usage (Only applies to on-premise, not cloud) options are: LowMemory, MaxPerformance, Balanced, BalancedTemp, HighPerformance {string} options.cloudEndPoint This setting only affects cloud engine, not on-premise. Choose a non default endpoint for the cloud request engine {string} options.cloudRequestOrigin This setting only affects cloud engine, not on-premise. Set the value to use for the Origin header when making requests to the cloud service.