common

Type Members

1. type EnrichmentMap = Map[String, Enrichment]

   

   Type alias for a map whose keys are enrichment names and whose values are enrichments

2. sealed class EtlException extends RuntimeException

   

   The parent for our ETL-specific exceptions

   The parent for our ETL-specific exceptions

   Note that the SnowPlow ETL does **not** use exceptions for control flow - it uses Scalaz Validation and ValidationNel objects.

   However two types of exception we do support are:

   1. FatalEtlException - should always cause the ETL to die 2. UnexpectedEtlException - ETL may die or continue, depending on the ETL config

3. trait EtlExceptionConstructors[E <: EtlException] extends AnyRef

   

   Holds ways of constructing the exception message from a Scalaz Validation or ValidatioNel.

   Holds ways of constructing the exception message from a Scalaz Validation or ValidatioNel.

   Mixed into the companion objects for the exceptions below.

4. case class FatalEtlError(msg: String) extends Error with Product with Serializable

   

   A fatal error in our ETL.

   A fatal error in our ETL.

   We are using this as a workaround: because Cascading cannot yet support excluding a specific Exception subclass (e.g. FatalEtlException) from a Failure Trap, we need to throw an Error instead.

   For details see: https://groups.google.com/forum/?fromgroups=#!topic/cascading-user/Ld5sg1baOyc

5. case class FatalEtlException(msg: String) extends EtlException with Product with Serializable

   

   A fatal exception in our ETL.

   A fatal exception in our ETL.

   Will only be thrown if the ETL cannot feasibly be run - **do not** try to catch it, or a kitten dies.

   This should be explicitly excluded from Cascading Failure Traps, as soon as they support this (Cascading 2.2).

6. type HttpHeaders = List[String]

   

   Type alias for HTTP headers

7. type JsonSchemaPairs = List[JsonSchemaPair]

   

   A (possibly empty) list of JsonSchemaPairs

8. type MaybeCollectorPayload = Option[CollectorPayload]

   

   Type alias for an Option-boxed CollectorPayload.

9. type MaybeEnrichedEvent = Option[EnrichedEvent]

   

   Type alias for an Option-boxed CanonicalOutput.

10. type MaybeString = Option[String]

    

    Type alias for an Option-boxed String

11. type RawEventParameters = Map[String, String]

    

    Parameters inside of a raw event

12. type ThrowableXor[+A] = \/[Throwable, A]

    

    Type alias for either Throwable or successful value It has Monad instance unlike Validation

13. case class UnexpectedEtlException(msg: String) extends EtlException with Product with Serializable

    

    An unexpected exception in our ETL.

    An unexpected exception in our ETL.

    Will be thrown in the event of an unexpected exception. How to handle it will depend on the setting of the Continue On Unexpected Error? flag passed in to the ETL.

14. type Validated[A] = Validation[NonEmptyList[String], A]

    

    Type alias for a ValidationNel containing Strings for Failure or any type of Success.

15. type ValidatedEnrichedEvent = Validation[NonEmptyList[String], EnrichedEvent]

    

    Type alias for either a ValidationNel containing Strings for Failure or a CanonicalOutput for Success.

16. type ValidatedMaybeCollectorPayload = Validation[NonEmptyList[String], MaybeCollectorPayload]

    

    Type alias for either a ValidationNel containing Strings for Failure or a MaybeCanonicalInput for Success.

17. type ValidatedMessage[A] = Validation[ProcessingMessage, A]

    

    Type alias for a Validation containing ProcessingMessages for Failure or any type for Success

18. type ValidatedNameValuePairs = Validation[String, List[NameValuePair]]

    

    Type alias for a Validation containing either error Strings or a NameValueNel.

19. type ValidatedNelMessage[A] = Validation[NonEmptyList[ProcessingMessage], A]

    

    Type alias for a ValidationNel containing ProcessingMessage for Failure or any type for Success

20. type ValidatedRawEvents = Validation[NonEmptyList[String], NonEmptyList[RawEvent]]

    

    Type alias for either a ValidationNel containing Strings for Failure or a List of RawEvents for Success.

21. type ValidatedString = Validation[String, String]

    

    Type alias for a Validation containing either an error String or a success String.

22. type ViewDimensionsTuple = (Integer, Integer)

    

    Capture a client's screen resolution