com.ibm.etcd.client.kv

Interface KvClient

All Known Implementing Classes:

EtcdKvClient

public interface KvClient

KV operations

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	KvClient.FluentCmpTarget
static interface	KvClient.FluentDeleteRequest
static interface	KvClient.FluentPutRequest
static interface	KvClient.FluentRangeRequest
static interface	KvClient.FluentRequest<FR extends KvClient.FluentRequest<FR,ReqT,RespT>,ReqT,RespT> Needed for backwards binary compatibility
static interface	KvClient.FluentTxnOps<FTO extends KvClient.FluentTxnOps<FTO>>
static interface	KvClient.FluentTxnRequest
static interface	KvClient.FluentTxnSuccOps
static interface	KvClient.FluentWatchRequest
static class	KvClient.RetryStrategy
static interface	KvClient.Watch Call KvClient.Watch.close() at any time to cancel the watch.
static interface	KvClient.WatchIterator Call KvClient.WatchIterator.close() at any time to cancel the watch.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.protobuf.ByteString	ALL_KEYS Used to get, watch or delete all of the keys (use with caution!)

Method Summary

Modifier and Type	Method and Description
KvClient.FluentTxnOps<?>	batch() Start a fluent batch transaction request
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.

Field Detail

ALL_KEYS

static final com.google.protobuf.ByteString ALL_KEYS

Used to get, watch or delete all of the keys (use with caution!)

Method Detail

get

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

Parameters:

request -

Returns:

future for RangeResponse

get

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

Parameters:

key - key to get or ALL_KEYS for the entire keyspace

txn

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

Parameters:

txn -

Returns:

future for TxnResponse

txnSync

TxnResponse txnSync(TxnRequest txn,
                    long timeoutMillis)

Parameters:

txn -

timeoutMillis -

Returns:

TxnResponse

txnIf

KvClient.FluentTxnRequest txnIf()

Start a fluent transaction request

batch

KvClient.FluentTxnOps<?> batch()

Start a fluent batch transaction request

put

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

Parameters:

request -

Returns:

future for PutResponse

put

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

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.

Parameters:

key -

value -

put

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

Put a key/value associated with a lease.

Parameters:

key -

value -

leaseId -

setLease

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

Associate an existing key/value with a lease.

Parameters:

key -

leaseId -

setValue

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.

Parameters:

key -

value -

delete

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

Parameters:

request -

Returns:

future for DeleteRangeResponse

delete

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

Start a fluent delete request

Parameters:

key - key to delete or ALL_KEYS to delete everything

watch

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

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.

Parameters:

request - the watch option

updates - watch update stream

Returns:

Watch watch reference

watch

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

Start a fluent watch request

Parameters:

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

See Also:

watch(WatchCreateRequest, StreamObserver)

compact

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

Perform a compaction.

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