com.snowplowanalytics.snowplow.enrich.common.adapters.registry

IgluAdapter

object IgluAdapter extends Adapter

Transforms a collector payload which either: 1. Provides a set of name-value pairs on a GET querystring with a &schema=schema uri parameter. 2. Provides a &schema=schema uri parameter on a POST querystring and a set of name-value pairs in the body.

Linear Supertypes
Adapter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IgluAdapter
  2. Adapter
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type FormatterFunc = (RawEventParameters) ⇒ JObject

    Definition Classes
    Adapter

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. val EventEncType: String

    Definition Classes
    Adapter
  7. val JsonSchemaDateTimeFormat: DateTimeFormatter

    Definition Classes
    Adapter
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def buildFormatter(bools: List[String] = Nil, ints: List[String] = Nil, dateTimes: DateTimeFields = None): (RawEventParameters) ⇒ JObject

    Convenience function to build a simple formatter of RawEventParameters.

    Convenience function to build a simple formatter of RawEventParameters.

    bools

    A List of keys whose values should be processed as boolean-like Strings

    ints

    A List of keys whose values should be processed as integer-like Strings

    returns

    a formatter function which converts RawEventParameters into a cleaned JObject

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  10. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. implicit val formats: DefaultFormats.type

    Definition Classes
    Adapter
  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  18. def lookupSchema(eventOpt: Option[String], vendor: String, index: Int, eventSchemaMap: Map[String, String]): Validated[String]

    USAGE: Multiple event payloads

    USAGE: Multiple event payloads

    Gets the correct Schema URI for the event passed from the vendor payload

    eventOpt

    An Option[String] which will contain a String or None

    vendor

    The vendor we are doing a schema lookup for; i.e. MailChimp or PagerDuty

    index

    The index of the event we are trying to get a schema URI for

    eventSchemaMap

    A map of event types linked to their relevant schema URI's

    returns

    the schema for the event or a Failure-boxed String if we cannot recognize the event type

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  19. def lookupSchema(eventOpt: Option[String], vendor: String, eventSchemaMap: Map[String, String]): Validated[String]

    USAGE: Single event payloads

    USAGE: Single event payloads

    Gets the correct Schema URI for the event passed from the vendor payload

    eventOpt

    An Option[String] which will contain a String or None

    vendor

    The vendor we are doing a schema lookup for; i.e. MailChimp or PagerDuty

    eventSchemaMap

    A map of event types linked to their relevant schema URI's

    returns

    the schema for the event or a Failure-boxed String if we cannot recognize the event type

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. def rawEventsListProcessor(rawEventsList: List[Validated[RawEvent]]): ValidatedRawEvents

    USAGE: Multiple event payloads

    USAGE: Multiple event payloads

    Processes a list of Validated RawEvents into a ValidatedRawEvents object. If there were any Failures in the list we will only return these.

    rawEventsList

    The list of RawEvents that needs to be processed

    returns

    the ValidatedRawEvents which will be comprised of either Successful RawEvents or Failures

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toContexts(contextJson: JValue): JValue

    Creates a Snowplow custom contexts entity by nesting the provided JValue in a self-describing envelope for the custom contexts.

    Creates a Snowplow custom contexts entity by nesting the provided JValue in a self-describing envelope for the custom contexts.

    returns

    the self-describing unstructured event

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  26. def toMap(parameters: List[NameValuePair]): Map[String, String]

    Converts a NonEmptyList of name:value pairs into a Map.

    Converts a NonEmptyList of name:value pairs into a Map.

    parameters

    A NonEmptyList of name:value pairs

    returns

    the name:value pairs in Map form

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  27. def toRawEvents(payload: CollectorPayload)(implicit resolver: Resolver): ValidatedRawEvents

    Converts a CollectorPayload instance into raw events.

    Converts a CollectorPayload instance into raw events. Currently we only support a single event Iglu-compatible self-describing event passed in on the querystring.

    payload

    The CollectorPaylod containing one or more raw events as collected by a Snowplow collector

    resolver

    (implicit) The Iglu resolver used for schema lookup and validation. Not used

    returns

    a Validation boxing either a NEL of RawEvents on Success, or a NEL of Failure Strings

    Definition Classes
    IgluAdapterAdapter
  28. def toString(): String

    Definition Classes
    AnyRef → Any
  29. def toUnstructEvent(eventJson: JValue): JValue

    Creates a Snowplow unstructured event by nesting the provided JValue in a self-describing envelope for the unstructured event.

    Creates a Snowplow unstructured event by nesting the provided JValue in a self-describing envelope for the unstructured event.

    eventJson

    The event which we will nest into the unstructured event

    returns

    the self-describing unstructured event

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  30. def toUnstructEventParams(tracker: String, qsParams: RawEventParameters, schema: String, eventJson: JValue, platform: String): RawEventParameters

    Fabricates a Snowplow unstructured event from the supplied parameters.

    Fabricates a Snowplow unstructured event from the supplied parameters. Note that to be a valid Snowplow unstructured event, the event must contain e, p and tv parameters, so we make sure to set those.

    tracker

    The name and version of this tracker

    qsParams

    The query-string parameters we will nest into the unstructured event

    schema

    The schema key which defines this unstructured event as a String

    eventJson

    The event which we will nest into the unstructured event

    platform

    The default platform to assign the event to

    returns

    the raw-event parameters for a valid Snowplow unstructured event

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  31. def toUnstructEventParams(tracker: String, parameters: RawEventParameters, schema: String, formatter: (RawEventParameters) ⇒ JObject, platform: String): RawEventParameters

    Fabricates a Snowplow unstructured event from the supplied parameters.

    Fabricates a Snowplow unstructured event from the supplied parameters. Note that to be a valid Snowplow unstructured event, the event must contain e, p and tv parameters, so we make sure to set those.

    tracker

    The name and version of this tracker

    parameters

    The raw-event parameters we will nest into the unstructured event

    schema

    The schema key which defines this unstructured event as a String

    formatter

    A function to take the raw event parameters and turn them into a correctly formatted JObject that should pass JSON Schema validation

    platform

    The default platform to assign the event to

    returns

    the raw-event parameters for a valid Snowplow unstructured event

    Attributes
    protected[com.snowplowanalytics.snowplow.enrich.common.adapters.registry]
    Definition Classes
    Adapter
  32. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Adapter

Inherited from AnyRef

Inherited from Any

Ungrouped