Object/Class

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

Input

Related Docs: class Input | package apirequest

Permalink

object Input extends Serializable

Companion object, containing common methods for input data manipulation and template context building

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Input
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type TemplateContext = Validation[NonEmptyList[String], Option[Map[String, @@[String, LastVal]]]]

    Permalink

    Validated Optional Map of Strings used to inject values into corresponding placeholders (key inside double curly braces) in template strings Failure means failure while accessing particular field, like invalid JSONPath, POJO-access, etc None means any of required fields were not found, so this lookup need to be skipped in future Tag used to not merge values on colliding keys (Tags.FirstVal can be used as well)

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 buildInputsMap(kvPairs: List[TemplateContext]): TemplateContext

    Permalink

    Build and merge template context out of list of all inputs

    Build and merge template context out of list of all inputs

    kvPairs

    list of validated optional (empty/single) kv pairs derived from POJO and JSON inputs

    returns

    validated optional template context

  6. def buildTemplateContext(inputs: List[Input], event: EnrichedEvent, derivedContexts: List[JObject], customContexts: List[JObject], unstructEvent: Option[JObject]): TemplateContext

    Permalink

    Get template context out of input configurations If any of inputs missing it will return None

    Get template context out of input configurations If any of inputs missing it will return None

    inputs

    input-configurations with for keys and instructions how to get values

    event

    current enriching event

    derivedContexts

    list of contexts derived on enrichment process

    customContexts

    list of custom contexts shredded out of event

    unstructEvent

    optional unstruct event object

    returns

    final template context

  7. def clone(): AnyRef

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

  8. val emptyTemplateContext: TemplateContext

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

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

  12. def getBySchemaCriterion(contexts: List[JObject], schemaCriterion: String): Option[JValue]

    Permalink

    Get data out of all JSON contexts matching schemaCriterion If more than one context match schemaCriterion, first will be picked

    Get data out of all JSON contexts matching schemaCriterion If more than one context match schemaCriterion, first will be picked

    contexts

    list of self-describing JSON contexts attached to event

    schemaCriterion

    part of URI

    returns

    first (optional) self-desc JSON matched schemaCriterion

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

    Permalink
    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  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. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  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 AnyRef

Inherited from Any

Ungrouped