Class/Object

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

AnonIpEnrichment

Related Docs: object AnonIpEnrichment | package registry

Permalink

case class AnonIpEnrichment(ipv4Octets: AnonIPv4Octets, ipv6Segments: AnonIPv6Segments) extends Enrichment with Product with Serializable

Config for an anon_ip enrichment

ipv4Octets

The number of octets (IPv4) to anonymize

ipv6Segments

The number of segments (IPv6) to anonymize

Linear Supertypes
Serializable, Serializable, Product, Equals, Enrichment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnonIpEnrichment
  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 AnonIpEnrichment(ipv4Octets: AnonIPv4Octets, ipv6Segments: AnonIPv6Segments)

    Permalink

    ipv4Octets

    The number of octets (IPv4) to anonymize

    ipv6Segments

    The number of segments (IPv6) to anonymize

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 IPv4MappedAddressPrefix: String

    Permalink
  5. val MaskChar: String

    Permalink
  6. def anonymizeIp(ipOrNull: String): String

    Permalink

    Anonymize the supplied IP address.

    Anonymize the supplied IP address.

    ipv4Octets is the number of octets in the IPv4 address to anonymize, starting from the right (example below)

    ipv6Segments is the number of segments in the IPv6 address to anonymize, starting from the right (exaple below)

    example:

    val enrichment = AnonIpEnrichment(Three, Four) enrichment.anonymizeIp("94.15.223.151")

    > "94.x.x.x"

    enrichment.anonymizeIp("2605:2700:0:3::4713:93e3")

    > "2605:2700:0:3:x:x:x:x"

    For IPv6 either the form defined in RFC 2732 or the literal IPv6 address format defined in RFC 2373 is accepted

    TODO: potentially update this to return a Validation error or a null if the IP address is somehow invalid or incomplete.

    returns

    the anonymized IP address

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. val ipv4Octets: AnonIPv4Octets

    Permalink

    The number of octets (IPv4) to anonymize

  14. val ipv6Segments: AnonIPv6Segments

    Permalink

    The number of segments (IPv6) to anonymize

  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. 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