Class

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

Output

Related Doc: package apirequest

Permalink

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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Output
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Output(schema: String, json: Option[JsonOutput])

    Permalink

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 clone(): AnyRef

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

  6. def describeJson(json: JValue): JObject

    Permalink

    Add schema (Iglu URI) to parsed instance

    Add schema (Iglu URI) to parsed instance

    json

    JValue parsed from API

    returns

    self-describing JSON instance

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

    Permalink
    Definition Classes
    AnyRef

  8. def extract(value: JValue): Validation[Throwable, JValue]

    Permalink

    Extract value specified by output's path

    Extract value specified by output's path

    value

    parsed API response

    returns

    extracted validated JSON

  9. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. val json: Option[JsonOutput]

    Permalink

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. def parse(apiResponse: String): Validation[Throwable, JValue]

    Permalink

    Transforming raw API response (text) to JSON (in future A => JSON) and extracting value by output's path

    Transforming raw API response (text) to JSON (in future A => JSON) and extracting value by output's path

    apiResponse

    response taken from ApiMethod

    returns

    parsed extracted JSON

  17. val schema: String

    Permalink

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

Inherited from Any

Ungrouped