consul4s.model.kv

Members list

Type members

Classlikes

final case class KVPair(Key: String, CreateIndex: Long, ModifyIndex: Long, LockIndex: Long, Flags: Long, Value: Option[String], Session: Option[String])

Value parameters

CreateIndex
  • is the internal index value that represents when the entry was created.
Flags
  • is an opaque unsigned integer that can be attached to each entry. Clients can choose to use this however makes sense for their application.
Key
  • is simply the full path of the entry.
LockIndex
  • is the number of times this key has successfully been acquired in a lock. If the lock is held, the Session key provides the session that owns the lock.
ModifyIndex
  • is the last index that modified this key. This index corresponds to the X-Consul-Index header value that is returned in responses, and it can be used to establish blocking queries by setting the ?index query parameter. You can even perform blocking queries against entire subtrees of the KV store: if ?recurse is provided, the returned X-Consul-Index corresponds to the latest ModifyIndex within the prefix, and a blocking query using that ?index will wait until any key within that prefix is updated.
Session
  • Specifies a session.
Value
  • is a base64-encoded blob of data.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all