registry

Type Members

1. case class AnonIpEnrichment(octets: AnonOctets) extends Enrichment with Product with Serializable

   

   Config for an anon_ip enrichment

   Config for an anon_ip enrichment

   octets

   The number of octets to anonymize

2. case class CampaignAttributionEnrichment(mediumParameters: List[String], sourceParameters: List[String], termParameters: List[String], contentParameters: List[String], campaignParameters: List[String], clickIdParameters: List[(String, String)]) extends Enrichment with Product with Serializable

   

   Config for a campaign_attribution enrichment

   Config for a campaign_attribution enrichment

   mediumParameters

   List of marketing medium parameters

   sourceParameters

   List of marketing source parameters

   termParameters

   List of marketing term parameters

   contentParameters

   List of marketing content parameters

   campaignParameters

   List of marketing campaign parameters

3. case class ClientAttributes(browserName: String, browserFamily: String, browserVersion: Option[String], browserType: String, browserRenderEngine: String, osName: String, osFamily: String, osManufacturer: String, deviceType: String, deviceIsMobile: Boolean) extends Product with Serializable

   

   Case class to wrap everything we can extract from the useragent using UserAgentUtils.

   Case class to wrap everything we can extract from the useragent using UserAgentUtils.

   Not to be declared inside a class Object http://stackoverflow.com/questions/17270003/why-are-classes-inside-scala-package-objects-dispreferred

4. case class CookieExtractorEnrichment(cookieNames: List[String]) extends Enrichment with Product with Serializable

   

   Enrichment extracting certain cookies from headers.

   Enrichment extracting certain cookies from headers.

   cookieNames

   Names of the cookies to be extracted

5. case class CurrencyConversionEnrichment(accountType: AccountType, apiKey: String, baseCurrency: String, rateAt: String) extends Enrichment with Product with Serializable

   

   Configuration for a currency_conversion enrichment

   Configuration for a currency_conversion enrichment

   apiKey

   OER authentication

   baseCurrency

   Currency to which to convert

   rateAt

   Which exchange rate to use - "EOD_PRIOR" for "end of previous day".

6. trait Enrichment extends AnyRef

   

   Trait inherited by every enrichment config case class

7. case class EventFingerprintEnrichment(algorithm: (String) ⇒ String, excludedParameters: List[String]) extends Enrichment with Product with Serializable

   

   Config for an event fingerprint enrichment

   Config for an event fingerprint enrichment

   algorithm

   Hashing algorithm

   excludedParameters

   List of querystring parameters to exclude from the calculation

   returns

   Event fingerprint

8. case class HttpHeaderExtractorEnrichment(headersPattern: String) extends Enrichment with Product with Serializable

   

   Enrichment extracting certain headers from headers.

   Enrichment extracting certain headers from headers.

   headersPattern

   Names of the headers to be extracted

9. case class IpLookupsEnrichment(geoTuple: Option[(String, URI, String)], ispTuple: Option[(String, URI, String)], domainTuple: Option[(String, URI, String)], connectionTypeTuple: Option[(String, URI, String)], localMode: Boolean) extends Enrichment with Product with Serializable

   

   Contains enrichments based on IP address.

   Contains enrichments based on IP address.

   geoTuple

   (Full URI to the geo lookup MaxMind data file, database name)

   ispTuple

   (Full URI to the ISP lookup MaxMind data file, database name)

   domainTuple

   (Full URI to the domain lookup MaxMind data file, database name)

   connectionTypeTuple

   (Full URI to the netspeed lookup MaxMind data file, database name)

   localMode

   Whether to use the local MaxMind data file. Enabled for tests.

10. case class JavascriptScriptEnrichment(script: Script) extends Enrichment with Product with Serializable

    

    Config for an JavaScript script enrichment

    Config for an JavaScript script enrichment

    script

    The compiled script ready for

11. case class MarketingCampaign(medium: Option[String], source: Option[String], term: Option[String], content: Option[String], campaign: Option[String], clickId: Option[String], network: Option[String]) extends Product with Serializable

    

    Class for a marketing campaign

    Class for a marketing campaign

    medium

    Campaign medium

    source

    Campaign source

    term

    Campaign term

    content

    Campaign content

    campaign

    Campaign name

    clickId

    Click ID

    network

    Advertising network

12. trait ParseableEnrichment extends AnyRef

    

    Trait to hold helpers relating to enrichment config

13. sealed trait PiiField extends AnyRef

    

    PiiField trait.

    PiiField trait. This corresponds to a configuration top-level field (i.e. either a scalar or a JSON field) along with a function to apply that strategy to the EnrichedEvent POJO (A scalar field is represented in config py "pojo")

14. final case class PiiJson(strategy: PiiStrategy, fieldMutator: Mutator, schemaCriterion: SchemaCriterion, jsonPath: String) extends PiiField with Product with Serializable

    

    Specifies a strategy to use, a field mutator where the JSON can be found in the EnrichedEvent POJO, a schema criterion to discriminate which contexts to apply this strategy to, and a json path within the contexts where this strategy will be applied (the path may correspond to multiple fields).

    Specifies a strategy to use, a field mutator where the JSON can be found in the EnrichedEvent POJO, a schema criterion to discriminate which contexts to apply this strategy to, and a json path within the contexts where this strategy will be applied (the path may correspond to multiple fields).

    strategy

    the strategy that should be applied

    fieldMutator

    the field mutator for the json field

    schemaCriterion

    the schema for which the strategy will be applied

    jsonPath

    the path where the strategy will be applied

15. case class PiiPseudonymizerEnrichment(fieldList: List[PiiField]) extends Enrichment with Product with Serializable

    

    The PiiPseudonymizerEnrichment runs after all other enrichments to find fields that are configured as PII (personally identifiable information) and apply some anonymization (currently only pseudonymization) on them.

    The PiiPseudonymizerEnrichment runs after all other enrichments to find fields that are configured as PII (personally identifiable information) and apply some anonymization (currently only pseudonymization) on them. Currently a single strategy for all the fields is supported due to the config format, and there is only one implemented strategy, however the enrichment supports a strategy per field.

    The user may specify two types of fields POJO or JSON. A POJO field is effectively a scalar field in the EnrichedEvent, whereas a JSON is a "context" formatted field and it can be wither a scalar in the case of unstruct_event or an array in the case of derived_events and contexts

    fieldList

    a list of configured PiiFields

16. final case class PiiScalar(strategy: PiiStrategy, fieldMutator: Mutator) extends PiiField with Product with Serializable

    

    Specifies a scalar field in POJO and the strategy that should be applied to it.

    Specifies a scalar field in POJO and the strategy that should be applied to it.

    strategy

    the strategy that should be applied

    fieldMutator

    the field mutator where the strategy will be applied

17. sealed trait PiiStrategy extends AnyRef

    

    PiiStrategy trait.

    PiiStrategy trait. This corresponds to a strategy to apply to a single field. Currently only String input is supported.

18. case class PiiStrategyPseudonymize(hashFunction: DigestFunction) extends PiiStrategy with Product with Serializable

    

    Implements a pseudonymization strategy using any algorithm known to DigestFunction

    Implements a pseudonymization strategy using any algorithm known to DigestFunction

    hashFunction

    the DigestFunction to apply

19. case class RefererParserEnrichment(domains: List[String]) extends Enrichment with Product with Serializable

    

    Config for a referer_parser enrichment

    Config for a referer_parser enrichment

    domains

    List of internal domains

20. case class ScrambleMapFunction(strategy: PiiStrategy) extends MapFunction with Product with Serializable

    

21. case class WeatherEnrichment(apiKey: String, cacheSize: Int, geoPrecision: Int, apiHost: String, timeout: Int) extends Enrichment with Product with Serializable

    

    Contains weather enrichments based on geo coordinates and time

    Contains weather enrichments based on geo coordinates and time

    apiKey

    weather provider API KEY

    cacheSize

    amount of days with prefetched weather

    geoPrecision

    rounder for geo lat/long floating, which allows to use more spatial precise weather stamps

    apiHost

    address of weather provider's API host

    timeout

    timeout in seconds to fetch weather from server