com.ibm.etcd.client.kv

Class EtcdKvClient

java.lang.Object

com.ibm.etcd.client.kv.EtcdKvClient

All Implemented Interfaces:

KvClient

public final class EtcdKvClient
extends Object
implements KvClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.etcd.client.kv.KvClient

KvClient.FluentCmpTarget, KvClient.FluentDeleteRequest, KvClient.FluentPutRequest, KvClient.FluentRangeRequest, KvClient.FluentRequest<FR extends KvClient.FluentRequest<FR,ReqT,RespT>,ReqT,RespT>, KvClient.FluentTxnOps<FTO extends KvClient.FluentTxnOps<FTO>>, KvClient.FluentTxnRequest, KvClient.FluentTxnSuccOps, KvClient.FluentWatchRequest, KvClient.RetryStrategy, KvClient.Watch, KvClient.WatchIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected GrpcClient	client

Fields inherited from interface com.ibm.etcd.client.kv.KvClient

ALL_KEYS

Constructor Summary

Constructors

Constructor and Description
EtcdKvClient(GrpcClient client)

Method Summary

Modifier and Type	Method and Description
KvClient.FluentTxnOps<?>	batch() Start a fluent batch transaction request
void	close()
com.google.common.util.concurrent.ListenableFuture<CompactionResponse>	compact(long minRevision, boolean physical) Perform a compaction.
KvClient.FluentDeleteRequest	delete(com.google.protobuf.ByteString key) Start a fluent delete request
com.google.common.util.concurrent.ListenableFuture<DeleteRangeResponse>	delete(DeleteRangeRequest request)
KvClient.FluentRangeRequest	get(com.google.protobuf.ByteString key)
com.google.common.util.concurrent.ListenableFuture<RangeResponse>	get(RangeRequest request)
KvClient.FluentPutRequest	put(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value) Put a key/value with no associated lease.
KvClient.FluentPutRequest	put(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long leaseId) Put a key/value associated with a lease.
com.google.common.util.concurrent.ListenableFuture<PutResponse>	put(PutRequest request)
KvClient.FluentPutRequest	setLease(com.google.protobuf.ByteString key, long leaseId) Associate an existing key/value with a lease.
KvClient.FluentPutRequest	setValue(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value) Put a key/value without affecting its lease association if the key already exists.
com.google.common.util.concurrent.ListenableFuture<TxnResponse>	txn(TxnRequest txn)
KvClient.FluentTxnRequest	txnIf() Start a fluent transaction request
TxnResponse	txnSync(TxnRequest txn, long timeoutMillis)
KvClient.FluentWatchRequest	watch(com.google.protobuf.ByteString key) Start a fluent watch request
KvClient.Watch	watch(WatchCreateRequest request, io.grpc.stub.StreamObserver<WatchUpdate> updates) Watch watches on a key or prefix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

client

protected final GrpcClient client

Constructor Detail

EtcdKvClient

public EtcdKvClient(GrpcClient client)

Method Detail

get

public com.google.common.util.concurrent.ListenableFuture<RangeResponse> get(RangeRequest request)

Specified by:

get in interface KvClient

Returns:

future for RangeResponse

get

public KvClient.FluentRangeRequest get(com.google.protobuf.ByteString key)

Specified by:

get in interface KvClient

Parameters:

key - key to get or KvClient.ALL_KEYS for the entire keyspace

txn

public com.google.common.util.concurrent.ListenableFuture<TxnResponse> txn(TxnRequest txn)

Specified by:

txn in interface KvClient

Returns:

future for TxnResponse

txnIf

public KvClient.FluentTxnRequest txnIf()

Description copied from interface: KvClient

Start a fluent transaction request

Specified by:

txnIf in interface KvClient

batch

public KvClient.FluentTxnOps<?> batch()

Description copied from interface: KvClient

Start a fluent batch transaction request

Specified by:

batch in interface KvClient

txnSync

public TxnResponse txnSync(TxnRequest txn,
                           long timeoutMillis)

Specified by:

txnSync in interface KvClient

Returns:

TxnResponse

put

public com.google.common.util.concurrent.ListenableFuture<PutResponse> put(PutRequest request)

Specified by:

put in interface KvClient

Returns:

future for PutResponse

put

public KvClient.FluentPutRequest put(com.google.protobuf.ByteString key,
                                     com.google.protobuf.ByteString value)

Description copied from interface: KvClient

Put a key/value with no associated lease. If the key already exists, its value will be updated and any lease association will be cleared.

Specified by:

put in interface KvClient

put

public KvClient.FluentPutRequest put(com.google.protobuf.ByteString key,
                                     com.google.protobuf.ByteString value,
                                     long leaseId)

Description copied from interface: KvClient

Put a key/value associated with a lease.

Specified by:

put in interface KvClient

setLease

public KvClient.FluentPutRequest setLease(com.google.protobuf.ByteString key,
                                          long leaseId)

Description copied from interface: KvClient

Associate an existing key/value with a lease.

Specified by:

setLease in interface KvClient

setValue

public KvClient.FluentPutRequest setValue(com.google.protobuf.ByteString key,
                                          com.google.protobuf.ByteString value)

Description copied from interface: KvClient

Put a key/value without affecting its lease association if the key already exists.

Specified by:

setValue in interface KvClient

delete

public com.google.common.util.concurrent.ListenableFuture<DeleteRangeResponse> delete(DeleteRangeRequest request)

Specified by:

delete in interface KvClient

Returns:

future for DeleteRangeResponse

delete

public KvClient.FluentDeleteRequest delete(com.google.protobuf.ByteString key)

Description copied from interface: KvClient

Start a fluent delete request

Specified by:

delete in interface KvClient

Parameters:

key - key to delete or KvClient.ALL_KEYS to delete everything

close

public void close()

watch

public KvClient.Watch watch(WatchCreateRequest request,
                            io.grpc.stub.StreamObserver<WatchUpdate> updates)

Description copied from interface: KvClient

Watch watches on a key or prefix. The watched updates will be notified via onWatch. Updates may or may not include a list of events - if the provided list is null the update is communicating a progression in the global revision of the store. A first update is guaranteed to be triggered (with or without events) immediately upon successful establishment of the watch. If the watch is slow or the required rev is compacted, the watch request might be cancelled from the server-side and the onError observer will be called with a RevisionCompactedException.

Specified by:

watch in interface KvClient

Parameters:

request - the watch option

updates - watch update stream

Returns:

Watch watch reference

watch

public KvClient.FluentWatchRequest watch(com.google.protobuf.ByteString key)

Description copied from interface: KvClient

Start a fluent watch request

Specified by:

watch in interface KvClient

Parameters:

key - key to watch or KvClient.ALL_KEYS to watch the entire keyspace

See Also:

KvClient.watch(WatchCreateRequest, StreamObserver)

compact

public com.google.common.util.concurrent.ListenableFuture<CompactionResponse> compact(long minRevision,
                                                                                      boolean physical)

Description copied from interface: KvClient

Perform a compaction.

Specified by:

compact in interface KvClient

Parameters:

minRevision - the lowest revision to retain in the kv store history

physical - if true the request will not return until the compaction is physically applied to the local database such that compacted entries are totally removed from the backend database