ClientListArgs (Lettuce 6.3.3.BUILD-SNAPSHOT API)

java.lang.Object
- io.lettuce.core.ClientListArgs

All Implemented Interfaces:

CompositeArgument
```
public class ClientListArgs
extends Object
implements CompositeArgument
```
Argument list builder for the Redis CLIENT LIST command.
ClientListArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

6.3

Author:

Mikhael Sokolov

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ClientListArgs.Builder
Builder entry points for ClientListArgs.

Constructor Summary

Constructors
Constructor Description

ClientListArgs()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<K,V> void`	`build(CommandArgs<K,V> args)`	Build command arguments and contribute arguments to `CommandArgs`.
`ClientListArgs`	`ids(long... ids)`	Filter the clients with its client `ids`.
`ClientListArgs`	`type(io.lettuce.core.ClientListArgs.Type type)`	This filters the connections of all the clients in the specified `ClientListArgs.Type`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClientListArgs
```
public ClientListArgs()
```
- Method Detail
  - ids
```
public ClientListArgs ids(long... ids)
```
    Filter the clients with its client ids.
    
    Parameters:
    
    ids - client ids
    
    Returns:
    
    this ClientListArgs.
  - type
```
public ClientListArgs type(io.lettuce.core.ClientListArgs.Type type)
```
    This filters the connections of all the clients in the specified ClientListArgs.Type. Note that clients blocked into the MONITOR command are considered to belong to the normal class.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
    
    this ClientListArgs.
  - build
```
public <K,V> void build(CommandArgs<K,V> args)
```
    Description copied from interface: CompositeArgument
    
    Build command arguments and contribute arguments to 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.
    
    Specified by:
    
    build in interface CompositeArgument
    
    Type Parameters:
    
    K - Key type.
    
    V - Value type.
    
    Parameters:
    
    args - the command arguments, must not be null.