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

Output

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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def describeJson(json: JValue): JObject

    Add schema (Iglu URI) to parsed instance

    Add schema (Iglu URI) to parsed instance

    json

    JValue parsed from API

    returns

    self-describing JSON instance

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

    Definition Classes
    AnyRef

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

    Extract value specified by output's path

    Extract value specified by output's path

    value

    parsed API response

    returns

    extracted validated JSON

  11. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. val json: Option[JsonOutput]

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    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

  19. val schema: String

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

    Definition Classes
    AnyRef

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped