Class/Object

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

YauaaEnrichment

Related Docs: object YauaaEnrichment | package registry

Permalink

final case class YauaaEnrichment(cacheSize: Option[Int]) extends Enrichment with Product with Serializable

Class for YAUAA enrichment, which tries to parse and analyze the user agent string and extract as many relevant attributes as possible, like for example the device class.

cacheSize

Amount of user agents already parsed that stay in cache for faster parsing.

Linear Supertypes
Serializable, Serializable, Product, Equals, Enrichment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. YauaaEnrichment
  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 YauaaEnrichment(cacheSize: Option[Int])

    Permalink

    cacheSize

    Amount of user agents already parsed that stay in cache for faster parsing.

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. val cacheSize: Option[Int]

    Permalink

    Amount of user agents already parsed that stay in cache for faster parsing.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val contextSchema: String

    Permalink
  8. val defaultDeviceClass: String

    Permalink
  9. val defaultResult: Map[String, String]

    Permalink
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def 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
    Enrichment
  12. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getYauaaContext(userAgent: String): Validation[String, JObject]

    Permalink

    Gets the result of YAUAA user agent analysis as self-describing JSON, for a specific event.

    Gets the result of YAUAA user agent analysis as self-describing JSON, for a specific event. Any non-fatal error will return failure.

    userAgent

    User agent of the event.

    returns

    Attributes retrieved thanks to the user agent (if any), as self-describing JSON.

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  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. def parseUserAgent(userAgent: String): Map[String, String]

    Permalink

    Gets the map of attributes retrieved by YAUAA from the user agent.

    Gets the map of attributes retrieved by YAUAA from the user agent.

    returns

    Map with all the fields extracted by YAUAA by parsing the user agent. If the input is null or empty, a map with just the DeviceClass set to UNKNOWN is returned.

  20. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. 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