51Degrees IP Intelligence for Node.js

IpIntelligenceCloudPipelineBuilder Class Reference

Detailed Description

Extension of pipelineBuilder class that allows for the quick generation of an IP intelligence cloud pipeline.

Adds share usage, caching.

Examples
cloud/metadata-console/metaData.js.

Inheritance diagram for IpIntelligenceCloudPipelineBuilder:

[legend]

Collaboration diagram for IpIntelligenceCloudPipelineBuilder:

[legend]

Public Member Functions

 constructor ({ licenceKeys=null, resourceKey=null, requestedProperties=null, cacheSize=null, cloudEndPoint=null, cloudRequestOrigin=null })
 Constructor for IpIntelligenceCloudPipelineBuilder.

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()

IpIntelligenceCloudPipelineBuilder::constructor ( { licenceKeys=null, resourceKey=null, requestedProperties=null, cacheSize=null, cloudEndPoint=null, cloudRequestOrigin=null })
inline

Constructor for IpIntelligenceCloudPipelineBuilder.

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.cloud-ipintelligencecloudpipelinebuilder.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
{number}options.cacheSize size of the default cache (includes cache if set).
{string}options.cloudEndPoint Choose a non default endpoint for the cloud request engine
{string}options.cloudRequestOrigin The value to set the Origin header to when making requests to the cloud service