SetKeyValue

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

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new SetKeyValue(key: String, value: Option[String] = None, compareAndSet: Option[Int] = None, acquire: Option[SessionID] = None, release: Option[SessionID] = None)

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

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
val acquire: Option[SessionID]

Attempts to take a lock on the key using the provided session ID
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
val compareAndSet: Option[Int]

Will only write the key/value of this value matches the ModifyIndex of the key stored in Consul
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val key: String

The name/path of the key (e.g.
The name/path of the key (e.g. foo/bar/my-data)
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
val release: Option[SessionID]

Attempts to release a lock on the key using the provided session ID
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val value: Option[String]

Optional value of the key/data
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withAcquire(sessionID: SessionID): SetKeyValue
def withCompareAndSet(cas: Int): SetKeyValue
def withRelease(sessionID: SessionID): SetKeyValue
def withValue(value: String): SetKeyValue
def withValue(value: JsValue): SetKeyValue

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object SetKeyValue | package consul

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

Instance Constructors

new SetKeyValue(key: String, value: Option[String] = None, compareAndSet: Option[Int] = None, acquire: Option[SessionID] = None, release: Option[SessionID] = None)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val acquire: Option[SessionID]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val compareAndSet: Option[Int]

final def eq(arg0: AnyRef): Boolean

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val key: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val release: Option[SessionID]

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

val value: Option[String]

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

def withAcquire(sessionID: SessionID): SetKeyValue

def withCompareAndSet(cas: Int): SetKeyValue

def withRelease(sessionID: SessionID): SetKeyValue

def withValue(value: String): SetKeyValue

def withValue(value: JsValue): SetKeyValue

Deprecated Value Members

def finalize(): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped