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

JsonOutput

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

Instance Constructors

  1. new JsonOutput(jsonPath: String)

    jsonPath

    JSON Path to required value

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

    Definition Classes
    AnyRef

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

    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

  10. def finalize(): Unit

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

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

    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

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

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. val jsonPath: String

    JSON Path to required value

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

    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

  19. val path: String

    Definition Classes
    JsonOutput → ApiOutput

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

Inherited from AnyRef

Inherited from Any

Ungrouped