Class

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

WeatherEnrichment

Related Doc: package registry

Permalink

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

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

Linear Supertypes
Serializable, Serializable, Product, Equals, Enrichment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WeatherEnrichment
  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 WeatherEnrichment(apiKey: String, cacheSize: Int, geoPrecision: Int, apiHost: String, timeout: Int)

    Permalink

    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

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. val apiHost: String

    Permalink

    address of weather provider's API host

  5. val apiKey: String

    Permalink

    weather provider API KEY

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val cacheSize: Int

    Permalink

    amount of days with prefetched weather

  8. def clone(): AnyRef

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. val geoPrecision: Int

    Permalink

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

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getWeatherContext(latitude: Option[Float], longitude: Option[Float], time: Option[DateTime]): Validation[String, JObject]

    Permalink

    Get weather context as JSON for specific event Any non-fatal error will return failure and thus whole event will be filtered out in future

    Get weather context as JSON for specific event Any non-fatal error will return failure and thus whole event will be filtered out in future

    latitude

    enriched event optional latitude (probably null)

    longitude

    enriched event optional longitude (probably null)

    time

    enriched event optional time (probably null)

    returns

    weather stamp as self-describing JSON object

  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. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. val timeout: Int

    Permalink

    timeout in seconds to fetch weather from server

  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