Class/Object

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

IpLookupsEnrichment

Related Docs: object IpLookupsEnrichment | package registry

Permalink

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.

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, Enrichment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IpLookupsEnrichment
  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 IpLookupsEnrichment(geoTuple: Option[(String, URI, String)], ispTuple: Option[(String, URI, String)], domainTuple: Option[(String, URI, String)], connectionTypeTuple: Option[(String, URI, String)], localMode: Boolean)

    Permalink

    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.

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. val connectionTypeTuple: Option[(String, URI, String)]

    Permalink

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

  7. val domainTuple: Option[(String, URI, String)]

    Permalink

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

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def extractIpInformation(ip: String): IpLookupResult

    Permalink

    Extract the geo-location using the client IP address.

    Extract the geo-location using the client IP address. If the IPv4 contains a port, it is removed before performing the lookup.

    ip

    The client's IP address to use to lookup the client's geo-location

    returns

    an IpLookupResult

  10. val filesToCache: List[(URI, FinalPath)]

    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
    IpLookupsEnrichment → Enrichment

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. val geoTuple: Option[(String, URI, String)]

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. val ispTuple: Option[(String, URI, String)]

    Permalink

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

  16. val localMode: Boolean

    Permalink

    Whether to use the local MaxMind data file.

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

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

    Permalink
    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  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