consul

Type Members

1. case class ConsulHost(host: String, port: Int = 8500) extends Product with Serializable

   

   Connection information to a Consul instance

   Connection information to a Consul instance

   host

   The host

   port

   Optional port (default 8500)

2. case class DeleteKeyValue(key: String, compareAndSet: Option[Int] = None, recursive: Boolean = false) extends Product with Serializable

   

   Data for deleting a key/value

   Data for deleting a key/value

   key

   The name/path of the key (e.g. foo/bar/my-data)

   compareAndSet

   Will only delete the key/value of this value matches the ModifyIndex of the key stored in Consul

   recursive

   If all key/values in the provided path shall be deleted

3. case class GetKeyValue(key: String, modifyIndex: Option[Int] = None, maxWait: Option[FiniteDuration] = None, recursive: Boolean = false) extends Product with Serializable

   

   Data for getting a key/value

   Data for getting a key/value

   key

   The name/path of the key (e.g. foo/bar/my-data)

   modifyIndex

   Optional modification index value to block on

   maxWait

   Optional max wait time, used in conjunction with modifyIndex

   recursive

   If keys in the path are to be recursively fetched

4. case class KeyValue(createIndex: Int, modifyIndex: Int, lockIndex: Int, flags: Int, key: String, value: Option[String], session: Option[String]) extends Product with Serializable

   

   Represents a key/value stored in Consul

   Represents a key/value stored in Consul

   createIndex

   The CreateIndex value as stored in Consul

   modifyIndex

   The ModifyIndex value as stored in Consul

   lockIndex

   The LockIndex value as stored in Consul

   flags

   The Flags value as stored in Consul

   key

   The name/path of the key

   value

   The value in plain string format already Base64 decoded

   session

   Optional owner (session ÍD) of the key

5. case class NoSuchKeyException(path: String) extends Exception with Product with Serializable

   

6. case class SemaphoreDestroyed(name: String) extends Exception with Product with Serializable

   

   Indicates that the .destroy method has been invoked on semaphore

   Indicates that the .destroy method has been invoked on semaphore

   name

   The name of the semaphore

7. case class Session(name: Option[String] = None, lockDelay: Option[FiniteDuration] = None, node: Option[String] = None, behavior: Option[String] = None, ttl: Option[FiniteDuration] = None) extends Product with Serializable

   

   Represents stored session data in Consul

   Represents stored session data in Consul

   name

   Optional name of the session

   lockDelay

   Optional lock delay

   node

   Optional Consul node for the session

   behavior

   Optional behavior of the session

   ttl

   Optional Time-To-Live of the session, not providing this will in practice be a session that never times out

8. type SessionID = String

   

9. case class SetKeyValue(key: String, value: Option[String] = None, compareAndSet: Option[Int] = None, acquire: Option[SessionID] = None, release: Option[SessionID] = None) extends Product with Serializable

   

   Data for setting a key/value

   Data for setting a key/value

   key

   The name/path of the key (e.g. foo/bar/my-data)

   value

   Optional value of the key/data

   compareAndSet

   Will only write the key/value of this value matches the ModifyIndex of the key stored in Consul

   acquire

   Attempts to take a lock on the key using the provided session ID

   release

   Attempts to release a lock on the key using the provided session ID