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

apirequest

package apirequest

Visibility
  1. Public
  2. All

Type Members

  1. sealed trait ApiOutput[A] extends AnyRef

    Common trait for all API output formats

  2. case class ApiRequestEnrichment(inputs: List[Input], api: HttpApi, outputs: List[Output], cache: Cache) extends Enrichment with Product with Serializable

  3. case class Authentication(httpBasic: Option[HttpBasic]) extends Product with Serializable

    Helper class to configure authentication for HTTP API

  4. case class Cache(size: Int, ttl: Int) extends Product with Serializable

    Just LRU cache

  5. case class HttpApi(method: String, uri: String, timeout: Int, authentication: Authentication) extends Product with Serializable

    API client able to make HTTP requests

  6. case class HttpBasic(username: Option[String], password: Option[String]) extends Product with Serializable

    Container for HTTP Basic auth credentials

  7. case class Input(key: String, pojo: Option[PojoInput], json: Option[JsonInput]) extends Product with Serializable

    Container for key with one (and only one) of possible input sources Basically, represents a key for future template context and way to get value out of EnrichedEvent, custom context, derived event or unstruct event.

  8. case class InvalidStateException(message: String) extends Throwable with Product with Serializable

  9. case class JsonInput(field: String, schemaCriterion: String, jsonPath: String) extends Product with Serializable

  10. case class JsonOutput(jsonPath: String) extends ApiOutput[JValue] with Product with Serializable

    Preference for extracting JSON from API output

  11. case class JsonPathException(message: String) extends Throwable with Product with Serializable

  12. case class Output(schema: String, json: Option[JsonOutput]) extends Product with Serializable

    Base trait for API output format Primary intention of these classes is to perform transformation of API raw output to self-describing JSON instance

  13. case class PojoInput(field: String) extends Product with Serializable

    Describes how to take key from POJO source

  14. case class ValueNotFoundException(message: String) extends Throwable with Product with Serializable

Value Members

  1. object ApiRequestEnrichment extends Serializable

    Companion object containing common methods for requests and manipulating data

  2. object ApiRequestEnrichmentConfig extends ParseableEnrichment

    Lets us create an ApiRequestEnrichmentConfig from a JValue

  3. object HttpApi extends Serializable

  4. object Input extends Serializable

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

Ungrouped