jetcd

Interface EtcdClient

public interface EtcdClient

The Etcd client API.

Method Summary

Modifier and Type	Method and Description
void	compareAndSwap(java.lang.String key, java.lang.String oldValue, java.lang.String newValue) Compare the value at a given key and swap with newValue if the oldValue matches.
void	delete(java.lang.String key) Delete value for the given key.
java.lang.String	get(java.lang.String key) Retrieve the value of the given key, if set.
java.util.Map<java.lang.String,java.lang.String>	list(java.lang.String path) List directory at given path.
void	set(java.lang.String key, java.lang.String value) Set value for the given key.
void	set(java.lang.String key, java.lang.String value, int ttl) Set value for the given key with given TTL.
java.lang.String	version()

Method Detail

version

java.lang.String version()
                  throws EtcdException

Returns:

Version of the etcd instance

Throws:

EtcdException - in case of an error

get

java.lang.String get(java.lang.String key)
              throws EtcdException

Retrieve the value of the given key, if set.

Parameters:

key - Key to look up

Returns:

value Value for the given key

Throws:

EtcdException - in case of an error (e.g. key doesn't exist)

set

void set(java.lang.String key,
         java.lang.String value)
  throws EtcdException

Set value for the given key.

Parameters:

key - Key to set value for

value - New value for the key

Throws:

EtcdException - in case of an error

set

void set(java.lang.String key,
         java.lang.String value,
         int ttl)
  throws EtcdException

Set value for the given key with given TTL.

Parameters:

key - Key to set value for

value - New value for the key

ttl - Key will expire after these many seconds

Throws:

EtcdException - in case of an error

delete

void delete(java.lang.String key)
     throws EtcdException

Delete value for the given key.

Parameters:

key - Key to delete value for

Throws:

EtcdException - in case of an error

list

java.util.Map<java.lang.String,java.lang.String> list(java.lang.String path)
                                               throws EtcdException

List directory at given path.

Parameters:

path - Given path

Returns:

Map of key,value pairs under the path

Throws:

EtcdException - in case of an error

compareAndSwap

void compareAndSwap(java.lang.String key,
                    java.lang.String oldValue,
                    java.lang.String newValue)
             throws EtcdException

Compare the value at a given key and swap with newValue if the oldValue matches.

Parameters:

key - Key to test/set value at

oldValue - Old value

newValue - New value

Throws:

EtcdException - in case of an error