Class/Object

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

HttpApi

Related Docs: object HttpApi | package apirequest

Permalink

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

API client able to make HTTP requests

method

HTTP method

uri

URI template

timeout

time in milliseconds after which request can be considered failed

authentication

auth preferences

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpApi
  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 HttpApi(method: String, uri: String, timeout: Int, authentication: Authentication)

    Permalink

    method

    HTTP method

    uri

    URI template

    timeout

    time in milliseconds after which request can be considered failed

    authentication

    auth preferences

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. val authentication: Authentication

    Permalink

    auth preferences

  6. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. val method: String

    Permalink

    HTTP method

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. def perform(url: String, body: Option[String] = None): Validation[Throwable, String]

    Permalink

    Primary API method, taking kv-context derived from event (POJO and contexts), generating request and sending it

    Primary API method, taking kv-context derived from event (POJO and contexts), generating request and sending it

    url

    URL to query

    body

    optional request body

    returns

    self-describing JSON ready to be attached to event contexts

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

    Permalink
    Definition Classes
    AnyRef

  17. val timeout: Int

    Permalink

    time in milliseconds after which request can be considered failed

  18. val uri: String

    Permalink

    URI template

  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