public class RestoreArgs extends Object implements CompositeArgument
RestoreArgs.Builder
and call the methods: ttl(…)
.
RestoreArgs
is a mutable object and instances should be used only once to avoid shared mutable state.
Modifier and Type | Class and Description |
---|---|
static class |
RestoreArgs.Builder
Builder entry points for
XAddArgs . |
Constructor and Description |
---|
RestoreArgs() |
Modifier and Type | Method and Description |
---|---|
RestoreArgs |
absttl()
TTL will represent an absolute Unix timestamp (in milliseconds) in which the key will expire.
|
RestoreArgs |
absttl(boolean absttl)
TTL will represent an absolute Unix timestamp (in milliseconds) in which the key will expire.
|
<K,V> void |
build(CommandArgs<K,V> args)
Build command arguments and contribute arguments to
CommandArgs . |
RestoreArgs |
frequency(long frequency)
Set the logarithmic access frequency counter of the object stored at the specified key.
|
RestoreArgs |
idleTime(long idleTime)
Set the number of seconds since the object stored at the specified key is idle (not requested by read or write
operations).
|
RestoreArgs |
replace()
Replaces existing keys if the target key already exists.
|
RestoreArgs |
replace(boolean replace)
Replaces existing keys if the target key already exists.
|
RestoreArgs |
ttl(Duration ttl)
Set TTL in
milliseconds after restoring the key. |
RestoreArgs |
ttl(long milliseconds)
Set TTL in
milliseconds after restoring the key. |
public RestoreArgs ttl(long milliseconds)
milliseconds
after restoring the key.milliseconds
- time to live.this
.public RestoreArgs ttl(Duration ttl)
milliseconds
after restoring the key.ttl
- time to live.this
.public RestoreArgs replace()
this
.public RestoreArgs replace(boolean replace)
replace
- true
to enable replacing of existing keys.this
.public RestoreArgs absttl()
this
.public RestoreArgs absttl(boolean absttl)
absttl
- true
to apply absolute TTL instead of a relative remaining TTL.this
.public RestoreArgs idleTime(long idleTime)
idleTime
- the idle time when using a LRU eviction policy.this
.public RestoreArgs frequency(long frequency)
frequency
- the access frequency when using a LFU eviction policy.this
.public <K,V> void build(CommandArgs<K,V> args)
CompositeArgument
CommandArgs
.
Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.
build
in interface CompositeArgument
K
- Key type.V
- Value type.args
- the command arguments, must not be null
.Copyright © 2021 lettuce.io. All rights reserved.