Class

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

JsonOutput

Related Doc: package apirequest

Permalink

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

Preference for extracting JSON from API output

jsonPath

JSON Path to required value

Linear Supertypes
Serializable, Serializable, Product, Equals, ApiOutput[JValue], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonOutput
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ApiOutput
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JsonOutput(jsonPath: String)

    Permalink

    jsonPath

    JSON Path to required value

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. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def extract(json: JValue): Validation[Throwable, JValue]

    Permalink

    Proxy function for query which wrap missing value in error

    Proxy function for query which wrap missing value in error

    json

    JSON value to look in

    returns

    validated found JSON, with absent value treated like failure

    Definition Classes
    JsonOutput → ApiOutput

  8. def finalize(): Unit

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

  9. def get(response: String): Validation[Throwable, JValue]

    Permalink

    Try to parse string as JSON and extract value by JSON PAth

    Try to parse string as JSON and extract value by JSON PAth

    response

    API response assumed to be JSON

    returns

    validated extracted value

    Definition Classes
    ApiOutput

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. val jsonPath: String

    Permalink

    JSON Path to required value

  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(response: String): Validation[Throwable, JValue]

    Permalink

    Parse raw response into validated Output format (XML, JSON)

    Parse raw response into validated Output format (XML, JSON)

    response

    API response assumed to be JSON

    returns

    validated JSON

    Definition Classes
    JsonOutput → ApiOutput

  17. val path: String

    Permalink
    Definition Classes
    JsonOutput → ApiOutput

  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 ApiOutput[JValue]

Inherited from AnyRef

Inherited from Any

Ungrouped