com.coreos.jetcd

Interface Lease

All Superinterfaces:

AutoCloseable, CloseableClient

All Known Implementing Classes:

LeaseImpl

public interface Lease
extends CloseableClient

Interface of KeepAlive talking to etcd.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Lease.KeepAliveListener KeepAliveListener listens for LeaseKeepAliveResponse of a given leaseID.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<LeaseGrantResponse>	grant(long ttl) New a lease with ttl value.
Lease.KeepAliveListener	keepAlive(long leaseId) keep the given lease alive forever.
CompletableFuture<LeaseKeepAliveResponse>	keepAliveOnce(long leaseId) keep alive one lease only once.
CompletableFuture<LeaseRevokeResponse>	revoke(long leaseId) revoke one lease and the key bind to this lease will be removed.
CompletableFuture<LeaseTimeToLiveResponse>	timeToLive(long leaseId, LeaseOption leaseOption) retrieves the lease information of the given lease ID.

Methods inherited from interface com.coreos.jetcd.internal.impl.CloseableClient

close

Method Detail

grant

CompletableFuture<LeaseGrantResponse> grant(long ttl)

New a lease with ttl value.

Parameters:

ttl - ttl value, unit seconds

revoke

CompletableFuture<LeaseRevokeResponse> revoke(long leaseId)

revoke one lease and the key bind to this lease will be removed.

Parameters:

leaseId - id of the lease to revoke

keepAliveOnce

CompletableFuture<LeaseKeepAliveResponse> keepAliveOnce(long leaseId)

keep alive one lease only once.

Parameters:

leaseId - id of lease to keep alive once

Returns:

The keep alive response

timeToLive

CompletableFuture<LeaseTimeToLiveResponse> timeToLive(long leaseId,
                                                      LeaseOption leaseOption)

retrieves the lease information of the given lease ID.

Parameters:

leaseId - id of lease

leaseOption - LeaseOption

Returns:

LeaseTimeToLiveResponse wrapped in CompletableFuture

keepAlive

Lease.KeepAliveListener keepAlive(long leaseId)

keep the given lease alive forever.

Parameters:

leaseId - lease to be keep alive forever.

Returns:

a KeepAliveListener that listens for KeepAlive responses.