com.ibm.etcd.client.lease

Interface LeaseClient

All Known Implementing Classes:

EtcdLeaseClient

public interface LeaseClient

Lease operations

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LeaseClient.FluentGrantRequest
static interface	LeaseClient.FluentMaintainRequest

Method Summary

Modifier and Type	Method and Description
default com.google.common.util.concurrent.ListenableFuture<LeaseGrantResponse>	create(long ttlSecs) Deprecated. use the more flexible grant(long)
com.google.common.util.concurrent.ListenableFuture<LeaseGrantResponse>	create(long leaseId, long ttlSecs) Deprecated. use the more flexible grant(long)
LeaseClient.FluentGrantRequest	grant(long ttlSecs) Start a fluent grant request for "one time" lease establishment.
com.google.common.util.concurrent.ListenableFuture<LeaseKeepAliveResponse>	keepAliveOnce(long leaseId)
com.google.common.util.concurrent.ListenableFuture<LeaseLeasesResponse>	list() List all existing leases Supported in versions >= 3.3 only
LeaseClient.FluentMaintainRequest	maintain() Maintain a "persistent" lease.
com.google.common.util.concurrent.ListenableFuture<LeaseRevokeResponse>	revoke(long leaseId)
com.google.common.util.concurrent.ListenableFuture<LeaseRevokeResponse>	revoke(long leaseId, boolean ensureWithRetries)
default com.google.common.util.concurrent.ListenableFuture<LeaseTimeToLiveResponse>	ttl(long leaseId)
com.google.common.util.concurrent.ListenableFuture<LeaseTimeToLiveResponse>	ttl(long leaseId, boolean includeKeys)

Method Detail

create

@Deprecated
com.google.common.util.concurrent.ListenableFuture<LeaseGrantResponse> create(long leaseId,
                                                                                          long ttlSecs)

Deprecated. use the more flexible grant(long)

Parameters:

leaseId -

ttlSecs -

Returns:

future for LeaseGrantResponse

create

@Deprecated
default com.google.common.util.concurrent.ListenableFuture<LeaseGrantResponse> create(long ttlSecs)

Deprecated. use the more flexible grant(long)

Parameters:

ttlSecs -

Returns:

future for LeaseGrantResponse

grant

LeaseClient.FluentGrantRequest grant(long ttlSecs)

Start a fluent grant request for "one time" lease establishment. If the lease is to be kept alive for some period, consider creating a PersistentLease via the maintain() method.

Parameters:

ttlSecs -

revoke

com.google.common.util.concurrent.ListenableFuture<LeaseRevokeResponse> revoke(long leaseId)

Parameters:

leaseId -

Returns:

future for LeaseRevokeResponse

revoke

com.google.common.util.concurrent.ListenableFuture<LeaseRevokeResponse> revoke(long leaseId,
                                                                               boolean ensureWithRetries)

Parameters:

leaseId -

ensureWithRetries - if true, the asynchronous request will be retried continuously in the background after connection failures (between back-off pauses)

Returns:

future for LeaseRevokeResponse

ttl

com.google.common.util.concurrent.ListenableFuture<LeaseTimeToLiveResponse> ttl(long leaseId,
                                                                                boolean includeKeys)

Parameters:

leaseId -

includeKeys -

Returns:

future for LeaseTimeToLiveResponse

ttl

default com.google.common.util.concurrent.ListenableFuture<LeaseTimeToLiveResponse> ttl(long leaseId)

Parameters:

leaseId -

Returns:

future for LeaseTimeToLiveResponse

keepAliveOnce

com.google.common.util.concurrent.ListenableFuture<LeaseKeepAliveResponse> keepAliveOnce(long leaseId)

Parameters:

leaseId -

Returns:

future for LeaseKeepAliveResponse

list

com.google.common.util.concurrent.ListenableFuture<LeaseLeasesResponse> list()

List all existing leases

Supported in versions >= 3.3 only

Returns:

future for LeaseLeasesResponse

maintain

LeaseClient.FluentMaintainRequest maintain()

Maintain a "persistent" lease. This will keep a lease alive indefinitely, creating or recreating it if it doesn't exist. It can be cancelled/revoked by closing the returned PersistentLease object.

Specifying a lease id is optional. If not provided it will be server-assigned. The return PersistentLease is also a future, which will be completed with the lease id when it is granted/confirmed.

NOTE sole "ownership" of the lease is assumed - i.e. the lease should not be revoked elsewhere.