public interface BoundKeyOperations<K>
As the rest of the APIs, if the underlying connection is pipelined or queued/in multi mode, all methods will return null.
Modifier and Type | Method and Description |
---|---|
default Boolean |
expire(Duration timeout)
Sets the key time-to-live/expiration.
|
Boolean |
expire(long timeout,
TimeUnit unit)
Sets the key time-to-live/expiration.
|
Boolean |
expireAt(Date date)
Sets the key time-to-live/expiration.
|
default Boolean |
expireAt(Instant expireAt)
Sets the key time-to-live/expiration.
|
Long |
getExpire()
Returns the expiration of this key.
|
K |
getKey()
Returns the key associated with this entity.
|
DataType |
getType()
Returns the associated Redis type.
|
Boolean |
persist()
Removes the expiration (if any) of the key.
|
void |
rename(K newKey)
Renames the key.
|
K getKey()
@Nullable DataType getType()
@Nullable Long getExpire()
@Nullable default Boolean expire(Duration timeout)
timeout
- must not be null.IllegalArgumentException
- if the timeout is null.@Nullable Boolean expire(long timeout, TimeUnit unit)
timeout
- expiration valueunit
- expiration unit@Nullable Boolean expireAt(Date date)
date
- expiration date@Nullable default Boolean expireAt(Instant expireAt)
expireAt
- expiration time.IllegalArgumentException
- if the instant is null or too large to represent as a Date
.@Nullable Boolean persist()
void rename(K newKey)
newKey
- new key. Must not be null.Copyright © 2011–2022 Pivotal Software, Inc.. All rights reserved.