io.keen.client.scala

Writer

trait Writer extends AccessLevel

A Client mixing in Writer can make Keen IO API calls requiring a write key.

A write key must be configured in the Client's Settings or the writeKey field must otherwise be set e.g. with an anonymous class override.

Self Type
Writer with Client
Example:
  1. Initializing a Client with write access

    val keen = new Client with Writer {
    override val writeKey = "myWriteKey"
    }
Exceptions thrown
MissingCredential

if a write key is not configured.

See also

https://keen.io/docs/security/

Linear Supertypes
AccessLevel, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Writer
  2. AccessLevel
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val authority: String

    Definition Classes
    AccessLevel
  2. abstract val scheme: String

    Definition Classes
    AccessLevel
  3. abstract val version: String

    Definition Classes
    AccessLevel

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. val MaxSendIntervalEvents: Long

    Attributes
    protected
  5. val MaxSendIntervalSeconds: Long

    Attributes
    protected
  6. val MinSendIntervalEvents: Long

    Attributes
    protected
  7. val MinSendIntervalSeconds: Long

    Attributes
    protected
  8. def addEvent(collection: String, event: String): Future[Response]

    Publish a single event.

    Publish a single event. See Event Collection Resource.

    collection

    The collection to which the event will be added.

    event

    The event

  9. def addEvents(events: String): Future[Response]

    Publish multiple events.

    Publish multiple events. See Event Resource.

    events

    The events to add to the project.

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. val batchSize: Integer

  12. val batchTimeout: Integer

  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def doRequest(path: String, method: String, key: String, body: Option[String] = None, params: Map[String, Option[String]] = Map.empty): Future[Response]

    Attributes
    protected
    Definition Classes
    AccessLevel
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  17. val eventStore: EventStore

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. val projectId: String

    Definition Classes
    AccessLevel
  26. def queueEvent(collection: String, event: String): Unit

    Queue events locally for subsequent publishing.

    Queue events locally for subsequent publishing.

    collection

    The collection to which the event will be added.

    event

    The event

  27. val scheduledThreadPool: Option[ScheduledThreadPoolExecutor]

    Schedule sending of queued events.

    Schedule sending of queued events.

    Attributes
    protected
  28. val sendIntervalEvents: Integer

  29. val sendIntervalSeconds: Integer

  30. def sendQueuedEvents(): Unit

    Sends all queued events, removing events from the queue as events are successfully sent.

  31. def sendQueuedEventsAsync(): Unit

    Asynchronously sends all queued events.

  32. def shutdown(): Unit

    Safely shuts down scheduledThreadPool before sending all events remaining in eventStore.

  33. val shutdownDelay: Integer

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

    Definition Classes
    AnyRef
  35. def toString(): String

    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. val writeKey: String

    A write key required to make API calls that write data.

Inherited from AccessLevel

Inherited from AnyRef

Inherited from Any

Ungrouped