Class

io.keen.client.scala

Settings

Related Doc: package scala

Permalink

class Settings extends AnyRef

Configuration settings for Keen IO Client.

Settings can be parsed from config files, properties, environment variables, etc. as supported by Typesafe Config.

Source
Settings.scala
Exceptions thrown

ConfigException.Missing if required configuration keys are not provided.

ConfigException.WrongType if a given configuration value is not of the required or sensibly coercible type.

Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. Settings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Settings(config: Config)

    Permalink

    Creates a new Settings instance, validating that all required keys are present in the given com.typesafe.config.Config.

    Creates a new Settings instance, validating that all required keys are present in the given com.typesafe.config.Config.

    config

    A Typesafe Config instance containing at least the required settings under the "keen" path reflected in the reference file.

    Exceptions thrown

    ConfigException.Missing if required configuration keys are not provided.

    ConfigException.WrongType if a given configuration value is not of the required or sensibly coercible type.

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 batchSize: Integer

    Permalink

    The number of events sent in a single API call when flushing batches.

    The number of events sent in a single API call when flushing batches. From configuration key keen.queue.batch.size.

  6. val batchTimeout: FiniteDuration

    Permalink

    Timeout for each bulk write API call when flushing batches.

    Timeout for each bulk write API call when flushing batches. From configuration key keen.queue.batch.timeout.

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val environment: Option[String]

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    Any
  15. val masterKey: Option[String]

    Permalink

  16. val maxEventsPerCollection: Integer

    Permalink

    Default queue bound to limit events stored in a write cache for batched writes.

    Default queue bound to limit events stored in a write cache for batched writes. From configuration key keen.queue.queue.max-events-per-collection.

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

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. val projectId: String

    Permalink

    Keen IO project ID that clients will operate on by default.

    Keen IO project ID that clients will operate on by default. From configuration key keen.project-id.

  21. val readKey: Option[String]

    Permalink

  22. val sendIntervalDuration: FiniteDuration

    Permalink

    Time interval at which batches of queued event writes are scheduled to be flushed.

    Time interval at which batches of queued event writes are scheduled to be flushed. From configuration key keen.queue.send-interval.duration.

  23. val sendIntervalEvents: Integer

    Permalink

    Threshold of queued events at which flush of batches is triggered.

    Threshold of queued events at which flush of batches is triggered. From configuration key keen.queue.send-interval.events.

  24. val shutdownDelay: FiniteDuration

    Permalink

    Duration for which client will wait for scheduled batch flushes to complete when shutting down.

    Duration for which client will wait for scheduled batch flushes to complete when shutting down. From configuration key keen.queue.shutdown-delay.

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

    Permalink
    Definition Classes
    AnyRef
  26. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. val writeKey: Option[String]

    Permalink

Inherited from AnyRef

Inherited from Any

Batch

Settings for batch write functionality, such as implemented in BatchWriterClient.

Keys

Ungrouped