NodeSelectionServerAsyncCommands (Lettuce 6.2.3.RELEASE API)

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionAsyncCommands<K,V>
```
public interface NodeSelectionServerAsyncCommands<K,V>
```
Asynchronous executed commands on a node selection for Server Control.

Since:

4.0

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateAsyncNodeSelectionClusterApi

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AsyncExecutions<String>`	`bgrewriteaof()` Asynchronously rewrite the append-only file.
`AsyncExecutions<String>`	`bgsave()` Asynchronously save the dataset to disk.
`AsyncExecutions<String>`	`clientCaching(boolean enabled)` Control tracking of keys in the context of server-assisted client cache invalidation.
`AsyncExecutions<K>`	`clientGetname()` Get the current connection name.
`AsyncExecutions<Long>`	`clientGetredir()` Returns the client ID we are redirecting our tracking notifications to.
`AsyncExecutions<Long>`	`clientId()` Get the id of the current connection.
`AsyncExecutions<Long>`	`clientKill(KillArgs killArgs)` Kill connections of clients which are filtered by `killArgs`.
`AsyncExecutions<String>`	`clientKill(String addr)` Kill the connection of a client identified by ip:port.
`AsyncExecutions<String>`	`clientList()` Get the list of client connections.
`AsyncExecutions<String>`	`clientNoEvict(boolean on)` Sets the client eviction mode for the current connection.
`AsyncExecutions<String>`	`clientPause(long timeout)` Stop processing commands from clients for some time.
`AsyncExecutions<String>`	`clientSetname(K name)` Set the current connection name.
`AsyncExecutions<String>`	`clientTracking(TrackingArgs args)` Enables the tracking feature of the Redis server, that is used for server assisted client side caching.
`AsyncExecutions<Long>`	`clientUnblock(long id, UnblockType type)` Unblock the specified blocked client.
`AsyncExecutions<List<Object>>`	`command()` Returns an array reply of details about all Redis commands.
`AsyncExecutions<Long>`	`commandCount()` Get total number of Redis commands.
`AsyncExecutions<List<Object>>`	`commandInfo(CommandType... commands)` Returns an array reply of details about the requested commands.
`AsyncExecutions<List<Object>>`	`commandInfo(String... commands)` Returns an array reply of details about the requested commands.
`AsyncExecutions<Map<String,String>>`	`configGet(String... parameters)` Get the value of multiple pattern parameters.
`AsyncExecutions<Map<String,String>>`	`configGet(String parameter)` Get the value of a configuration parameter.
`AsyncExecutions<String>`	`configResetstat()` Reset the stats returned by INFO.
`AsyncExecutions<String>`	`configRewrite()` Rewrite the configuration file with the in memory configuration.
`AsyncExecutions<String>`	`configSet(Map<String,String> kvs)` Set multiple parameters to the given value.
`AsyncExecutions<String>`	`configSet(String parameter, String value)` Set a configuration parameter to the given value.
`AsyncExecutions<Long>`	`dbsize()` Return the number of keys in the selected database.
`AsyncExecutions<String>`	`debugCrashAndRecover(Long delay)` Crash and recover.
`AsyncExecutions<String>`	`debugHtstats(int db)` Get debugging information about the internal hash-table state.
`AsyncExecutions<String>`	`debugObject(K key)` Get debugging information about a key.
`AsyncExecutions<String>`	`debugReload()` Save RDB, clear the database and reload RDB.
`AsyncExecutions<String>`	`debugRestart(Long delay)` Restart the server gracefully.
`AsyncExecutions<String>`	`debugSdslen(K key)` Get debugging information about the internal SDS length.
`AsyncExecutions<String>`	`flushall()` Remove all keys from all databases.
`AsyncExecutions<String>`	`flushall(FlushMode flushMode)` Remove all keys from all databases using the specified `FlushMode`.
`AsyncExecutions<String>`	`flushallAsync()` Deprecated. since 6.1, use `flushall(FlushMode)` instead.
`AsyncExecutions<String>`	`flushdb()` Remove all keys from the current database.
`AsyncExecutions<String>`	`flushdb(FlushMode flushMode)` Remove all keys from the current database using the specified `FlushMode`.
`AsyncExecutions<String>`	`flushdbAsync()` Deprecated. since 6.1, use `flushdb(FlushMode)` instead.
`AsyncExecutions<String>`	`info()` Get information and statistics about the server.
`AsyncExecutions<String>`	`info(String section)` Get information and statistics about the server.
`AsyncExecutions<Date>`	`lastsave()` Get the UNIX time stamp of the last successful save to disk.
`AsyncExecutions<Long>`	`memoryUsage(K key)` Reports the number of bytes that a key and its value require to be stored in RAM.
`AsyncExecutions<String>`	`replicaof(String host, int port)` Make the server a replica of another instance.
`AsyncExecutions<String>`	`replicaofNoOne()` Promote server as master.
`AsyncExecutions<String>`	`save()` Synchronously save the dataset to disk.
`AsyncExecutions<String>`	`slaveof(String host, int port)` Deprecated. since 6.1.7, use `replicaof(String, int)` instead.
`AsyncExecutions<String>`	`slaveofNoOne()` Deprecated. since 6.1.7, use `replicaofNoOne()` instead.
`AsyncExecutions<List<Object>>`	`slowlogGet()` Read the slow log.
`AsyncExecutions<List<Object>>`	`slowlogGet(int count)` Read the slow log.
`AsyncExecutions<Long>`	`slowlogLen()` Obtaining the current length of the slow log.
`AsyncExecutions<String>`	`slowlogReset()` Resetting the slow log.
`AsyncExecutions<List<V>>`	`time()` Return the current server time.

- Method Detail
  - bgrewriteaof
```
AsyncExecutions<String> bgrewriteaof()
```
    Asynchronously rewrite the append-only file.
    
    Returns:
    
    String simple-string-reply always OK.
  - bgsave
```
AsyncExecutions<String> bgsave()
```
    Asynchronously save the dataset to disk.
    
    Returns:
    
    String simple-string-reply.
  - clientCaching
```
AsyncExecutions<String> clientCaching(boolean enabled)
```
    Control tracking of keys in the context of server-assisted client cache invalidation.
    
    Parameters:
    
    enabled - true to enable key tracking.
    
    Returns:
    
    String simple-string-reply OK.
    
    Since:
    
    6.0
  - clientGetname
```
AsyncExecutions<K> clientGetname()
```
    Get the current connection name.
    
    Returns:
    
    K bulk-string-reply The connection name, or a null bulk reply if no name is set.
  - clientGetredir
```
AsyncExecutions<Long> clientGetredir()
```
    Returns the client ID we are redirecting our tracking notifications to.
    
    Returns:
    
    the ID of the client we are redirecting the notifications to. The command returns -1 if client tracking is not enabled, or 0 if client tracking is enabled but we are not redirecting the notifications to any client.
    
    Since:
    
    6.0
  - clientId
```
AsyncExecutions<Long> clientId()
```
    Get the id of the current connection.
    
    Returns:
    
    Long The command just returns the ID of the current connection.
    
    Since:
    
    5.3
  - clientKill
```
AsyncExecutions<String> clientKill(String addr)
```
    Kill the connection of a client identified by ip:port.
    
    Parameters:
    
    addr - ip:port.
    
    Returns:
    
    String simple-string-reply OK if the connection exists and has been closed.
  - clientKill
```
AsyncExecutions<Long> clientKill(KillArgs killArgs)
```
    Kill connections of clients which are filtered by killArgs.
    
    Parameters:
    
    killArgs - args for the kill operation.
    
    Returns:
    
    Long integer-reply number of killed connections.
  - clientList
```
AsyncExecutions<String> clientList()
```
    Get the list of client connections.
    
    Returns:
    
    String bulk-string-reply a unique string, formatted as follows: One client connection per line (separated by LF), each line is composed of a succession of property=value fields separated by a space character.
  - clientNoEvict
```
AsyncExecutions<String> clientNoEvict(boolean on)
```
    Sets the client eviction mode for the current connection.
    
    Parameters:
    
    on - true will turn eviction mode on, and false will turn it off.
    
    Returns:
    
    String simple-string-reply OK.
    
    Since:
    
    6.2
  - clientPause
```
AsyncExecutions<String> clientPause(long timeout)
```
    Stop processing commands from clients for some time.
    
    Parameters:
    
    timeout - the timeout value in milliseconds.
    
    Returns:
    
    String simple-string-reply The command returns OK or an error if the timeout is invalid.
  - clientSetname
```
AsyncExecutions<String> clientSetname(K name)
```
    Set the current connection name.
    
    Parameters:
    
    name - the client name.
    
    Returns:
    
    simple-string-reply OK if the connection name was successfully set.
  - clientTracking
```
AsyncExecutions<String> clientTracking(TrackingArgs args)
```
    Enables the tracking feature of the Redis server, that is used for server assisted client side caching. Tracking messages are either available when using the RESP3 protocol or through Pub/Sub notification when using RESP2.
    
    Parameters:
    
    args - for the CLIENT TRACKING operation.
    
    Returns:
    
    String simple-string-reply OK.
    
    Since:
    
    6.0
  - clientUnblock
```
AsyncExecutions<Long> clientUnblock(long id,
                                    UnblockType type)
```
    Unblock the specified blocked client.
    
    Parameters:
    
    id - the client id.
    
    type - unblock type.
    
    Returns:
    
    Long integer-reply number of unblocked connections.
    
    Since:
    
    5.1
  - command
```
AsyncExecutions<List<Object>> command()
```
    Returns an array reply of details about all Redis commands.
    
    Returns:
    
    List<Object> array-reply.
  - commandCount
```
AsyncExecutions<Long> commandCount()
```
    Get total number of Redis commands.
    
    Returns:
    
    Long integer-reply of number of total commands in this Redis server.
  - commandInfo
```
AsyncExecutions<List<Object>> commandInfo(String... commands)
```
    Returns an array reply of details about the requested commands.
    
    Parameters:
    
    commands - the commands to query for.
    
    Returns:
    
    List<Object> array-reply.
  - commandInfo
```
AsyncExecutions<List<Object>> commandInfo(CommandType... commands)
```
    Returns an array reply of details about the requested commands.
    
    Parameters:
    
    commands - the commands to query for.
    
    Returns:
    
    List<Object> array-reply.
  - configGet
```
AsyncExecutions<Map<String,String>> configGet(String parameter)
```
    Get the value of a configuration parameter.
    
    Parameters:
    
    parameter - name of the parameter.
    
    Returns:
    
    Map<String, String> bulk-string-reply.
  - configGet
```
AsyncExecutions<Map<String,String>> configGet(String... parameters)
```
    Get the value of multiple pattern parameters.
    
    Parameters:
    
    parameters - patterns names of Redis server's configuration.
    
    Returns:
    
    Map<String, String> bulk-string-reply.
    
    Since:
    
    6.2
  - configResetstat
```
AsyncExecutions<String> configResetstat()
```
    Reset the stats returned by INFO.
    
    Returns:
    
    String simple-string-reply always OK.
  - configRewrite
```
AsyncExecutions<String> configRewrite()
```
    Rewrite the configuration file with the in memory configuration.
    
    Returns:
    
    String simple-string-reply OK when the configuration was rewritten properly. Otherwise an error is returned.
  - configSet
```
AsyncExecutions<String> configSet(String parameter,
                                  String value)
```
    Set a configuration parameter to the given value.
    
    Parameters:
    
    parameter - the parameter name.
    
    value - the parameter value.
    
    Returns:
    
    String simple-string-reply: OK when the configuration was set properly. Otherwise an error is returned.
  - configSet
```
AsyncExecutions<String> configSet(Map<String,String> kvs)
```
    Set multiple parameters to the given value.
    
    Parameters:
    
    kvs - the parameter name and value.
    
    Returns:
    
    String simple-string-reply: OK when the configuration was set properly. Otherwise an error is returned.
    
    Since:
    
    6.2
  - dbsize
```
AsyncExecutions<Long> dbsize()
```
    Return the number of keys in the selected database.
    
    Returns:
    
    Long integer-reply.
  - debugCrashAndRecover
```
AsyncExecutions<String> debugCrashAndRecover(Long delay)
```
    Crash and recover.
    
    Parameters:
    
    delay - optional delay in milliseconds.
    
    Returns:
    
    String simple-string-reply.
  - debugHtstats
```
AsyncExecutions<String> debugHtstats(int db)
```
    Get debugging information about the internal hash-table state.
    
    Parameters:
    
    db - the database number.
    
    Returns:
    
    String simple-string-reply.
  - debugObject
```
AsyncExecutions<String> debugObject(K key)
```
    Get debugging information about a key.
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    String simple-string-reply.
  - debugReload
```
AsyncExecutions<String> debugReload()
```
    Save RDB, clear the database and reload RDB.
    
    Returns:
    
    String simple-string-reply The commands returns OK on success.
  - debugRestart
```
AsyncExecutions<String> debugRestart(Long delay)
```
    Restart the server gracefully.
    
    Parameters:
    
    delay - optional delay in milliseconds.
    
    Returns:
    
    String simple-string-reply.
  - debugSdslen
```
AsyncExecutions<String> debugSdslen(K key)
```
    Get debugging information about the internal SDS length.
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    String simple-string-reply.
  - flushall
```
AsyncExecutions<String> flushall()
```
    Remove all keys from all databases.
    
    Returns:
    
    String simple-string-reply.
  - flushall
```
AsyncExecutions<String> flushall(FlushMode flushMode)
```
    Remove all keys from all databases using the specified FlushMode.
    
    Parameters:
    
    flushMode - the flush mode (sync/async).
    
    Returns:
    
    String simple-string-reply.
    
    Since:
    
    6.1
  - flushallAsync
```
@Deprecated
AsyncExecutions<String> flushallAsync()
```
    Deprecated. since 6.1, use flushall(FlushMode) instead.
    
    Remove all keys asynchronously from all databases.
    
    Returns:
    
    String simple-string-reply.
  - flushdb
```
AsyncExecutions<String> flushdb()
```
    Remove all keys from the current database.
    
    Returns:
    
    String simple-string-reply.
  - flushdb
```
AsyncExecutions<String> flushdb(FlushMode flushMode)
```
    Remove all keys from the current database using the specified FlushMode.
    
    Parameters:
    
    flushMode - the flush mode (sync/async).
    
    Returns:
    
    String simple-string-reply.
    
    Since:
    
    6.1
  - flushdbAsync
```
@Deprecated
AsyncExecutions<String> flushdbAsync()
```
    Deprecated. since 6.1, use flushdb(FlushMode) instead.
    
    Remove all keys asynchronously from the current database.
    
    Returns:
    
    String simple-string-reply.
  - info
```
AsyncExecutions<String> info()
```
    Get information and statistics about the server.
    
    Returns:
    
    String bulk-string-reply as a collection of text lines.
  - info
```
AsyncExecutions<String> info(String section)
```
    Get information and statistics about the server.
    
    Parameters:
    
    section - the section type: string.
    
    Returns:
    
    String bulk-string-reply as a collection of text lines.
  - lastsave
```
AsyncExecutions<Date> lastsave()
```
    Get the UNIX time stamp of the last successful save to disk.
    
    Returns:
    
    Date integer-reply an UNIX time stamp.
  - memoryUsage
```
AsyncExecutions<Long> memoryUsage(K key)
```
    Reports the number of bytes that a key and its value require to be stored in RAM.
    
    Returns:
    
    memory usage in bytes.
    
    Since:
    
    5.2
  - replicaof
```
AsyncExecutions<String> replicaof(String host,
                                  int port)
```
    Make the server a replica of another instance.
    
    Parameters:
    
    host - the host type: string.
    
    port - the port type: string.
    
    Returns:
    
    String simple-string-reply.
    
    Since:
    
    6.1.7
  - replicaofNoOne
```
AsyncExecutions<String> replicaofNoOne()
```
    Promote server as master.
    
    Returns:
    
    String simple-string-reply.
    
    Since:
    
    6.1.7
  - save
```
AsyncExecutions<String> save()
```
    Synchronously save the dataset to disk.
    
    Returns:
    
    String simple-string-reply The commands returns OK on success.
  - slaveof
```
AsyncExecutions<String> slaveof(String host,
                                int port)
```
    Deprecated. since 6.1.7, use replicaof(String, int) instead.
    
    Make the server a replica of another instance.
    
    Parameters:
    
    host - the host type: string.
    
    port - the port type: string.
    
    Returns:
    
    String simple-string-reply.
  - slaveofNoOne
```
AsyncExecutions<String> slaveofNoOne()
```
    Deprecated. since 6.1.7, use replicaofNoOne() instead.
    
    Promote server as master.
    
    Returns:
    
    String simple-string-reply.
  - slowlogGet
```
AsyncExecutions<List<Object>> slowlogGet()
```
    Read the slow log.
    
    Returns:
    
    List<Object> deeply nested multi bulk replies.
  - slowlogGet
```
AsyncExecutions<List<Object>> slowlogGet(int count)
```
    Read the slow log.
    
    Parameters:
    
    count - the count.
    
    Returns:
    
    List<Object> deeply nested multi bulk replies.
  - slowlogLen
```
AsyncExecutions<Long> slowlogLen()
```
    Obtaining the current length of the slow log.
    
    Returns:
    
    Long length of the slow log.
  - slowlogReset
```
AsyncExecutions<String> slowlogReset()
```
    Resetting the slow log.
    
    Returns:
    
    String simple-string-reply The commands returns OK on success.
  - time
```
AsyncExecutions<List<V>> time()
```
    Return the current server time.
    
    Returns:
    
    List<V> array-reply specifically: A multi bulk reply containing two elements: unix time in seconds. microseconds.

Interface NodeSelectionServerAsyncCommands<K,V>

Method Summary

Method Detail

bgrewriteaof

bgsave

clientCaching

clientGetname

clientGetredir

clientId

clientKill

clientKill

clientList

clientNoEvict

clientPause

clientSetname

clientTracking

clientUnblock

command

commandCount

commandInfo

commandInfo

configGet

configGet

configResetstat

configRewrite

configSet

configSet

dbsize

debugCrashAndRecover

debugHtstats

debugObject

debugReload

debugRestart

debugSdslen

flushall

flushall

flushallAsync

flushdb

flushdb

flushdbAsync

info

info

lastsave

memoryUsage

replicaof

replicaofNoOne

save

slaveof

slaveofNoOne

slowlogGet

slowlogGet

slowlogLen

slowlogReset

time