Class/Object

com.snowplowanalytics.snowplow.enrich.common.enrichments.registry

IabEnrichment

Related Docs: object IabEnrichment | package registry

Permalink

case class IabEnrichment(ipFile: Option[IabDatabase], excludeUaFile: Option[IabDatabase], includeUaFile: Option[IabDatabase], localMode: Boolean) extends Enrichment with Product with Serializable

Contains enrichments based on IAB Spiders&Robots lookup.

ipFile

(Full URI to the IAB excluded IP list, database name)

excludeUaFile

(Full URI to the IAB excluded user agent list, database name)

includeUaFile

(Full URI to the IAB included user agent list, database name)

localMode

Whether to use the local database file. Enabled for tests.

Linear Supertypes
Serializable, Serializable, Product, Equals, Enrichment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IabEnrichment
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Enrichment
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IabEnrichment(ipFile: Option[IabDatabase], excludeUaFile: Option[IabDatabase], includeUaFile: Option[IabDatabase], localMode: Boolean)

    Permalink

    ipFile

    (Full URI to the IAB excluded IP list, database name)

    excludeUaFile

    (Full URI to the IAB excluded user agent list, database name)

    includeUaFile

    (Full URI to the IAB included user agent list, database name)

    localMode

    Whether to use the local database file. Enabled for tests.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. val excludeUaFile: Option[IabDatabase]

    Permalink

    (Full URI to the IAB excluded user agent list, database name)

  8. val filesToCache: List[(URI, String)]

    Permalink

    Gets the list of files the enrichment requires cached locally.

    Gets the list of files the enrichment requires cached locally. The default implementation returns an empty list; if an enrichment requires files, it must override this method.

    returns

    A list of pairs, where the first entry in the pair indicates the (remote) location of the source file and the second indicates the local path where the enrichment expects to find the file.

    Definition Classes
    IabEnrichmentEnrichment
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getIabContext(userAgent: Option[String], ipAddress: Option[String], accurateAt: Option[DateTime]): Validation[String, JObject]

    Permalink

    Get the IAB response as a JSON context for a specific event

    Get the IAB response as a JSON context for a specific event

    userAgent

    enriched event optional user agent

    ipAddress

    enriched event optional IP address

    accurateAt

    enriched event optional datetime

    returns

    IAB response as a self-describing JSON object

  12. val includeUaFile: Option[IabDatabase]

    Permalink

    (Full URI to the IAB included user agent list, database name)

  13. val ipFile: Option[IabDatabase]

    Permalink

    (Full URI to the IAB excluded IP list, database name)

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. val localMode: Boolean

    Permalink

    Whether to use the local database file.

    Whether to use the local database file. Enabled for tests.

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Enrichment

Inherited from AnyRef

Inherited from Any

Ungrouped