All Classes

Class Description
AbstractInvocationHandler
Abstract base class for invocation handlers.
AbstractInvocationHandler.MethodTranslator  
AbstractRedisAsyncCommands<K,​V>
An asynchronous and thread-safe API for a Redis connection.
AbstractRedisClient
Base Redis client.
AbstractRedisReactiveCommands<K,​V>
A reactive and thread-safe API for a Redis connection.
AclCategory
Enum object describing Redis ACL categories.
AclSetuserArgs
Argument list builder for the Redis ACL SETUSER command.
AclSetuserArgs.Builder
Builder entry points for AclSetuserArgs.
AdaptiveRefreshTriggeredEvent
Event when a topology refresh is about to start by an adaptive refresh trigger.
AnnotationCommandSegmentFactory
CommandSegmentFactory implementation that creates CommandSegments considering Command and CommandNaming annotations.
AnnotationParameterNameDiscoverer
ParameterNameDiscoverer based on Param annotations to resolve parameter names.
AnnotationRedisCodecResolver
Annotation-based RedisCodecResolver.
AnnotationRedisCodecResolver.ParameterWrappers
Parameter wrapper support for types that encapsulate one or more parameter values.
ArrayOutput<K,​V>
List of objects and lists to support dynamic nested structures (List with mixed content of values and sublists).
AskRedirectionEvent
Event emitted on a ASK redirection.
AsyncCloseable
A AsyncCloseable is a resource that can be closed.
AsyncCommand<K,​V,​T>
An asynchronous redis command and its result.
AsyncConnectionPoolSupport
Asynchronous connection pool support for BoundedAsyncPool.
AsyncConnectionProvider<K,​T extends AsyncCloseable,​F extends CompletionStage<T>>
Non-blocking provider for connection objects.
AsyncExecutions<T>
Result holder for a command that was executed asynchronously on multiple nodes.
AsyncNodeSelection<K,​V>
Node selection with access to asynchronous executed commands on the set.
AsyncObjectFactory<T>
An interface defining life-cycle methods for instances to be served by an pool.
AsyncPool<T>
Interface declaring non-blocking object pool methods allowing to AsyncPool.acquire() and AsyncPool.release(Object) objects.
Base16
High-performance base16 (AKA hex) codec.
BaseNodeSelectionAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for basic commands.
BaseNodeSelectionCommands<K,​V>
Synchronous executed commands on a node selection for basic commands.
BasePool
Basic implementation of a pool configured through BasePoolConfig.
BasePoolConfig
Base configuration for an object pool declaring options for object validation.
BasePoolConfig.Builder
Builder for BasePoolConfig.
BaseRedisAsyncCommands<K,​V>
Asynchronous executed commands for basic commands.
BaseRedisCommandBuilder<K,​V>  
BaseRedisCommands<K,​V>
Synchronous executed commands for basic commands.
BaseRedisReactiveCommands<K,​V>
Reactive executed commands for basic commands.
Batcher
Command batcher to enqueue commands and flush a batch once a flush is requested or a configured command threshold is reached.
BatchException
Batch exception to collect multiple errors from batched command execution.
BatchExecutor
Batch executor interface to enforce command queue flushing using BatchSize.
BatchSize
Redis command method annotation declaring a command interface to use batching with a specified batchSize.
BitFieldArgs
Argument list builder for the Redis BITFIELD command.
BitFieldArgs.BitFieldType
Represents a bit field type with details about signed/unsigned and the number of bits.
BitFieldArgs.Builder
Builder entry points for BitFieldArgs.
BitFieldArgs.Offset
Represents a bit field offset.
BitFieldArgs.OverflowType
Represents the overflow types for the OVERFLOW subcommand argument.
BooleanListOutput<K,​V>
List of boolean output.
BooleanOutput<K,​V>
Boolean output.
BoundedAsyncPool<T>
Bounded asynchronous object pool.
BoundedPoolConfig
Configuration for asynchronous pooling using BoundedAsyncPool.
BoundedPoolConfig.Builder
Builder for BoundedPoolConfig.
BraveTracing
Tracing integration with OpenZipkin's Brave Tracer.
BraveTracing.BraveEndpoint
Tracing.Endpoint implementation for Zipkin's Endpoint.
BraveTracing.BraveTraceContext
TraceContext implementation for Brave's TraceContext.
BraveTracing.Builder
Builder for BraveTracing.
ByteArrayCodec
A RedisCodec that uses plain byte arrays without further transformations.
ByteArrayOutput<K,​V>
Byte array output.
CacheAccessor<K,​V>
Interface defining access to the client-side cache.
CacheFrontend<K,​V>
Interface defining a cache frontend for common cache retrieval operations that using Redis server-side caching assistance.
CacheFrontend.ValueRetrievalException
Wrapper exception to be thrown from CacheFrontend.get(Object, Callable) in case of the value loader callback failing with an exception.
ChannelMessage<K,​V>
Message payload for a subscription to a channel.
CipherCodec
A crypto RedisCodec that that allows transparent encryption/decryption of values.
CipherCodec.CipherSupplier
Represents a supplier of Cipher.
CipherCodec.KeyDescriptor
Descriptor to determine which crypto key to use.
ClaimedMessages<K,​V>
Value object representing the claimed messages reported through XAUTOCLAIM.
ClaimedMessagesOutput<K,​V>
ClassTypeInformation<S>
TypeInformation for a plain Class.
ClientOptions
Client Options to control the behavior of RedisClient.
ClientOptions.Builder
Builder for ClientOptions.
ClientOptions.DisconnectedBehavior
Behavior of connections in disconnected state.
ClientResources
Strategy interface to provide all the infrastructure building blocks like environment settings and thread pools so that the client can work with it properly.
ClientResources.Builder
Builder for ClientResources.
ClientSideCaching<K,​V>
Utility to provide server-side assistance for client-side caches.
ClusterClientOptions
Client Options to control the behavior of RedisClusterClient.
ClusterClientOptions.Builder
ClusterPartitionParser
Parser for node information output of CLUSTER NODES and CLUSTER SLAVES.
ClusterPushHandler
A handler object that provides access to RedisClusterPushListener.
ClusterSlotRange
Represents a range of slots together with its master and replicas.
ClusterSlotsParser
Parser for Redis CLUSTER SLOTS command output.
ClusterTopologyChangedEvent
Signals a discovered cluster topology change.
ClusterTopologyRefresh
Utility to refresh the cluster topology view based on Partitions.
ClusterTopologyRefreshOptions
Options to control the Cluster topology refreshing of RedisClusterClient.
ClusterTopologyRefreshOptions.Builder
ClusterTopologyRefreshOptions.RefreshTrigger
Available refresh triggers to signal early topology refreshing.
CodecAwareOutputFactoryResolver
RedisCodec-aware implementation of CommandOutputFactoryResolver.
Command
Redis command method annotation specifying a command string.
Command<K,​V,​T>
A Redis command with a command type, arguments and an optional output.
CommandArgs<K,​V>
Redis command arguments.
CommandArgsAccessor
Accessor for first encoded key, first string and first integer argument of CommandArgs.
CommandBaseEvent
Base class for Redis command events.
CommandBatching
Programmatic command batching API.
CommandCreationException
Exception thrown if a command cannot be constructed from a CommandMethod.
CommandDetail
Domain object describing Redis Command details.
CommandDetail.Flag  
CommandDetailParser
Parser for Redis COMMAND/COMMAND INFO output.
CommandEncoder
A netty ChannelHandler responsible for encoding commands.
CommandExpiryWriter
Extension to RedisChannelWriter that expires commands.
CommandFailedEvent
Event for a failed command.
CommandHandler
A netty ChannelHandler responsible for writing redis commands and reading responses from the server.
CommandHandler.LifecycleState  
CommandKeyword
Keyword modifiers for redis commands.
CommandLatencyCollector
MetricCollector for command latencies.
CommandLatencyCollectorOptions
Configuration interface for command latency collection.
CommandLatencyCollectorOptions.Builder
CommandLatencyEvent
Event that transports command latency metrics.
CommandLatencyId
Identifier for a command latency.
CommandLatencyRecorder
Interface defining a method to collect command latency metrics based upon command completion.
CommandListener
A listener for Redis command events.
CommandListenerWriter
Writer for command listeners.
CommandListenerWriter.CommandListenerMulticaster
Wraps multiple command listeners into one multicaster.
CommandMethod
Abstraction of a method that is designated to execute a Redis command method.
CommandMethodSyntaxException
Exception thrown if the command syntax is invalid.
CommandMetrics
Latency metrics for commands.
CommandMetrics.CommandLatency  
CommandNaming
Command naming strategy for Redis command methods.
CommandNaming.LetterCase  
CommandNaming.Strategy  
CommandOutput<K,​V,​T>
Base class for Redis command outputs.
CommandOutputFactory
Strategy interface to create CommandOutput given RedisCodec.
CommandOutputFactoryResolver
Strategy interface to resolve a CommandOutputFactory based on a OutputSelector.
CommandOutputResolverSupport
Commands
Marker interface for dynamic Redis commands.
CommandSegment
Value object representing a segment within a Redis Command.
CommandSegment.ArgumentContribution  
CommandSegmentFactory
Strategy interface to create CommandSegments for a CommandMethod.
CommandSegments
Value object abstracting multiple CommandSegments.
CommandStartedEvent
Event for a started command.
CommandSucceededEvent
Event for succeeded command.
CommandType
Redis commands.
CommandWrapper<K,​V,​T>
Wrapper for a command.
CommonsPool2ConfigConverter
Utility class to adapt Commons Pool 2 configuration to BoundedPoolConfig.
CompleteableCommand<T>
Extension to commands that provide registration of command completion callbacks.
CompositeArgument
Interface for composite command argument objects.
CompositeParameterNameDiscoverer
Composite ParameterNameDiscoverer to resolve parameter names using multiple ParameterNameDiscoverers.
CompressionCodec
A compressing/decompressing RedisCodec that wraps a typed codec and compresses values using GZIP or Deflate.
CompressionCodec.CompressionType  
ConnectedEvent
Event for a established TCP-level connection.
ConnectEvent
Event to connect to Redis.
ConnectionActivatedEvent
Event for a connection activation (after SSL-handshake, PING before activation, and buffered command replay).
ConnectionBuilder
Connection builder for connections.
ConnectionCreatedEvent
Event for a created connection object.
ConnectionDeactivatedEvent
Event for a connection deactivation.
ConnectionEvent
Interface for Connection-related events
ConnectionEvents
Close Events Facility.
ConnectionEvents.Reconnect
Internal event when a reconnect is initiated.
ConnectionEvents.Reset
Internal event when a channel is closed.
ConnectionFacade
Represents a stateful connection facade.
ConnectionFuture<T>
A ConnectionFuture represents the result of an asynchronous connection initialization.
ConnectionId
Connection identifier.
ConnectionInitializer
Initialize a connection to prepare it for usage.
ConnectionPoint
Interface for a connection point described with a host and port or socket.
ConnectionPoolSupport
Connection pool support for GenericObjectPool and SoftReferenceObjectPool.
ConnectionState
Internal connection state representing the negotiated ProtocolVersion and other options for connection initialization and connection state restoration.
ConnectionWatchdog
A netty ChannelHandler responsible for monitoring the channel and reconnecting when the connection is lost.
ConnectionWrapping
Utility to wrap pooled connections for return-on-close.
Consumer<K>
Value object representing a Stream consumer within a consumer group.
CopyArgs
Argument list builder for the Redis COPY command.
CopyArgs.Builder
Builder entry points for CopyArgs.
CRC16  
DateOutput<K,​V>
Date output with no milliseconds.
DeclaredCommandMethod
Abstraction of a method that is designated to execute a Redis command method.
DecodeBufferPolicies
Utility class to construct commonly used DecodeBufferPolicy objects.
DecodeBufferPolicy
Strategy defining the approach to discard bytes from the response aggregation buffer in CommandHandler.decode(ChannelHandlerContext ctx, ByteBuf buffer) to reclaim memory after various response decoding phases.
DecoratedCommand<K,​V,​T>
A decorated command allowing access to the underlying DecoratedCommand.getDelegate().
DefaultClientResources
Default instance of the client resources.
DefaultClientResources.Builder
DefaultCommandLatencyCollector
Default implementation of a CommandLatencyCollector for command latencies.
DefaultCommandLatencyCollectorOptions
The default implementation of CommandLatencyCollectorOptions.
DefaultCommandLatencyCollectorOptions.Builder
DefaultCommandLatencyEventPublisher
Default implementation of a CommandLatencyCollector for command latencies.
DefaultEndpoint
Default Endpoint implementation.
DefaultEventBus
Default implementation for an EventBus.
DefaultEventLoopGroupProvider
Default implementation which manages one event loop group instance per type.
DefaultEventLoopGroupProvider.ThreadFactoryProvider
Interface to provide a custom ThreadFactory.
DefaultEventPublisherOptions
The default implementation of CommandLatencyCollectorOptions.
DefaultEventPublisherOptions.Builder
DefaultMethodInvokingInterceptor
Invokes default interface methods.
DefaultMethods
Collection of utility methods to lookup MethodHandles for default interface Methods.
Delay
Base class for delays and factory class to create particular instances.
Delay.StatefulDelay
Interface to be implemented by stateful Delays.
DemandAware
Interface for demand-aware components.
DemandAware.Sink
A demand-aware DemandAware.Sink that accepts data.
DemandAware.Source
A DemandAware.Source provides data to a DemandAware and can be notified to produce more input for the command.
DirContextDnsResolver
DNS Resolver based on Java's com.sun.jndi.dns.DnsContextFactory.
DisconnectedEvent
Event for a disconnect on TCP-level.
DnsResolver
Users may implement this interface to override the normal DNS lookup offered by the OS.
DnsResolvers
Predefined DNS resolvers.
DoubleListOutput<K,​V>
List of Double output.
DoubleOutput<K,​V>
Double output, may be null.
Endpoint
Wraps a stateful Endpoint that abstracts the underlying channel.
EnumSetOutput<K,​V,​E extends Enum<E>>
EnumSet output.
EpollProvider Deprecated.
Use EpollProvider instead.
EpollProvider
Wraps and provides Epoll classes.
Event
Marker-interface for events that are published over the event bus.
EventBus
Interface for an EventBus.
EventLoopGroupProvider
EventLoopResources
Interface to encapsulate EventLoopGroup resources.
EventPublisherOptions
Configuration interface for command latency collection.
EventRecorder
Event recorder that can delegate events from the EventBus into a recording facility such as JFR.
EventRecorder.RecordableEvent
Interface defining a recordable event that is recorded on calling EventRecorder.RecordableEvent.record().
ExceptionFactory
Factory for Redis exceptions.
Exceptions
Exception handling and utils to operate on.
Executions<T>
Result holder for a command that was executed synchronously on multiple nodes.
ExecutionSpecificParameters
Parameters-implementation specific to execution.
ExecutionSpecificParameters.ExecutionAwareParameter  
FlushMode
Enum object describing flushing mode.
Futures
Utility methods for Future handling.
GenericMapOutput<K,​V>
Map of keys and objects output.
GenericTypeResolver
Helper class for resolving generic types against type variables.
GeoAddArgs
Argument list builder for the Redis GEOADD command starting from Redis 6.2.
GeoAddArgs.Builder
Builder entry points for ScanArgs.
GeoArgs
Argument list builder for the Redis GEORADIUS and GEORADIUSBYMEMBER commands.
GeoArgs.Builder
Builder entry points for GeoArgs.
GeoArgs.Sort
Sort order.
GeoArgs.Unit
Supported geo unit.
GeoCoordinates
A tuple consisting of numerical geo data points to describe geo coordinates (longitude/latitude coordinates according to WGS84).
GeoCoordinatesListOutput<K,​V>
A list output that creates a list with GeoCoordinates's.
GeoCoordinatesValueListOutput<K,​V>
A list output that creates a list with GeoCoordinates Values.
GeoRadiusStoreArgs<K>
Argument list builder for the Redis GEORADIUS command to store GEORADIUS results or GEORADIUS distances in a sorted set.
GeoRadiusStoreArgs.Builder
Builder entry points for GeoRadiusStoreArgs.
GeoSearch
Utility to create GeoSearch.GeoPredicate and GeoSearch.GeoRef objects to be used with GEOSEARCH.
GeoSearch.GeoPredicate
Geo predicate specifying a search scope.
GeoSearch.GeoRef<K>
Geo reference specifying a search starting point.
GeoValue<V>
A Geo value extension to Value.
GeoWithin<V>
Geo element within a certain radius.
GeoWithinListOutput<K,​V>
A list output that creates a list with either double/long or GeoCoordinates's.
GetExArgs
Argument list builder for the Redis GETEX command starting from Redis 6.2.
GetExArgs.Builder
Builder entry points for GetExArgs.
HostAndPort
An immutable representation of a host and port.
IntegerListOutput<K,​V>
List of 64-bit integer output.
IntegerOutput<K,​V>
64-bit integer output, may be null.
InvocationProxyFactory
Factory to create invocation proxies.
InvocationTargetProvider
Provides an invocation target object.
IOUringProvider
Wraps and provides io_uring classes.
JfrReconnectAttemptEvent
Flight recorder event variant of ReconnectAttemptEvent.
JfrReconnectFailedEvent
Flight recorder event variant of ReconnectFailedEvent.
Key
Marker annotation to declare a method parameter as key.
KeyListOutput<K,​V>
List of keys output.
KeyOutput<K,​V>
Key output.
KeyScanArgs
Argument list builder for the Redis SCAN command.
KeyScanArgs.Builder  
KeyScanCursor<K>
Cursor providing a list of keys.
KeyScanOutput<K,​V>
KeyScanCursor for scan cursor output.
KeyScanStreamingOutput<K,​V>
Streaming API for multiple Keys.
KeyStreamingChannel<K>
Streaming API for multiple Keys.
KeyStreamingOutput<K,​V>
Streaming-Output of Keys.
KeyValue<K,​V>
A key-value container extension to Value.
KeyValueListOutput<K,​V>
List of KeyValue output.
KeyValueOutput<K,​V>
Key-value pair output.
KeyValueScanStreamingOutput<K,​V>
Streaming-Output of Key Value Pairs.
KeyValueScoredValueOutput<K,​V>
KeyValue encapsulating ScoredValue.
KeyValueStreamingChannel<K,​V>
Streaming API for multiple keys and values (tuples).
KeyValueStreamingOutput<K,​V>
Streaming-Output of Key Value Pairs.
KillArgs
Argument list builder for the Redis CLIENT KILL command.
KillArgs.Builder
Builder entry points for KillArgs.
KqueueProvider Deprecated.
since 6.0, use KqueueProvider instead.
KqueueProvider
Wraps and provides kqueue classes.
LettuceAssert
Assertion utility class that assists in validating arguments.
LettuceCdiExtension
A portable CDI extension which registers beans for lettuce.
LettuceClassUtils
Miscellaneous class utility methods.
LettuceFactories
This class is part of the internal API and may change without further notice.
LettuceFutures
Utility to LettuceFutures.awaitAll(long, TimeUnit, Future[]) futures until they are done and to synchronize future execution using LettuceFutures.awaitOrCancel(RedisFuture, long, TimeUnit).
LettuceLists
Static utility methods for List instances.
LettuceSets
Static utility methods for Set instances.
LettuceStrings
Helper for String checks.
Limit
Value object for a slice of data (offset/count).
ListOfGenericMapsOutput<K,​V>
List of maps output.
ListOfMapsOutput<K,​V>
List of maps output.
ListSubscriber<T>
LMoveArgs
Argument list builder for the Redis BLMOVE and LMOVE commands.
LMoveArgs.Builder
Builder entry points for LMoveArgs.
LPosArgs
Argument list builder for the Redis LPOS command.
LPosArgs.Builder
Builder entry points for LPosArgs.
MapOutput<K,​V>
Map of keys and values output.
MappingSocketAddressResolver
Mapping SocketAddressResolver that allows mapping of RedisURI host and port components to redirect connection endpoint coordinates using a mapping function.
MapScanCursor<K,​V>
Scan cursor for maps.
MapScanOutput<K,​V>
MapScanCursor for scan cursor output.
MasterReplica
Master-Replica connection API.
MasterSlave Deprecated.
since 5.2, use MasterReplica
MethodInterceptor
Intercepts calls on an interface on its way to the target.
MethodInvocation
Description of an invocation to a method, given to an interceptor upon method-call.
MethodParameter
Helper class that encapsulates the specification of a method parameter, i.e.
MethodParametersAccessor
Accessor interface to method parameters during the actual invocation.
MetricCollector<T>
Generic metrics collector interface.
MetricEventPublisher
Event publisher which publishes metrics by the use of events.
MicrometerCommandLatencyRecorder
Micrometer implementation of CommandLatencyRecorder
MicrometerOptions
Configuration options for MicrometerCommandLatencyRecorder.
MicrometerOptions.Builder
Builder for MicrometerOptions.
MigrateArgs<K>
Argument list builder for the Redis MIGRATE command.
MigrateArgs.Builder
Builder entry points for MigrateArgs.
MovedRedirectionEvent
Event emitted on a MOVED redirection.
MultiOutput<K,​V>
Output of all commands within a MULTI block.
NestedMultiOutput<K,​V>
List of command outputs, possibly deeply nested.
NettyCustomizer
Strategy interface to customize netty Bootstrap and Channel via callback hooks.
NodeConnectionFactory
Factory interface to obtain connections to Redis cluster nodes.
NodeSelection<K,​V>
Node selection with access to synchronous executed commands on the set.
NodeSelectionAclAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for the ACL-API.
NodeSelectionAclCommands<K,​V>
Synchronous executed commands on a node selection for the ACL-API.
NodeSelectionAsyncCommands<K,​V>
Asynchronous and thread-safe Redis API to execute commands on a NodeSelectionSupport.
NodeSelectionCommands<K,​V>
Synchronous and thread-safe Redis API to execute commands on a NodeSelectionSupport.
NodeSelectionGeoAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for the Geo-API.
NodeSelectionGeoCommands<K,​V>
Synchronous executed commands on a node selection for the Geo-API.
NodeSelectionHashAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Hashes (Key-Value pairs).
NodeSelectionHashCommands<K,​V>
Synchronous executed commands on a node selection for Hashes (Key-Value pairs).
NodeSelectionHLLAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for HyperLogLog (PF* commands).
NodeSelectionHLLCommands<K,​V>
Synchronous executed commands on a node selection for HyperLogLog (PF* commands).
NodeSelectionKeyAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Keys (Key manipulation/querying).
NodeSelectionKeyCommands<K,​V>
Synchronous executed commands on a node selection for Keys (Key manipulation/querying).
NodeSelectionListAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Lists.
NodeSelectionListCommands<K,​V>
Synchronous executed commands on a node selection for Lists.
NodeSelectionPubSubAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Pub/Sub.
NodeSelectionPubSubCommands<K,​V>
Synchronous executed commands on a node selection for Pub/Sub.
NodeSelectionPubSubReactiveCommands<K,​V>
Reactive executed commands on a node selection for Pub/Sub.
NodeSelectionScriptingAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Scripting.
NodeSelectionScriptingCommands<K,​V>
Synchronous executed commands on a node selection for Scripting.
NodeSelectionServerAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Server Control.
NodeSelectionServerCommands<K,​V>
Synchronous executed commands on a node selection for Server Control.
NodeSelectionSetAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Sets.
NodeSelectionSetCommands<K,​V>
Synchronous executed commands on a node selection for Sets.
NodeSelectionSortedSetAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Sorted Sets.
NodeSelectionSortedSetCommands<K,​V>
Synchronous executed commands on a node selection for Sorted Sets.
NodeSelectionStreamAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Streams.
NodeSelectionStreamCommands<K,​V>
Synchronous executed commands on a node selection for Streams.
NodeSelectionStringAsyncCommands<K,​V>
Asynchronous executed commands on a node selection for Strings.
NodeSelectionStringCommands<K,​V>
Synchronous executed commands on a node selection for Strings.
NodeSelectionSupport<API,​CMD>
A node selection represents a set of Redis Cluster nodes.
OrderingReadFromAccessor
Accessor for ReadFrom ordering.
OutputRegistry
Registry for CommandOutput types and their factories.
OutputRegistryCommandOutputFactoryResolver
OutputSelector
Selector CommandOutputFactory resolution.
OutputType
Type descriptor for a CommandOutput.
Param
Annotation to bind method parameters using their name.
Parameter
Abstracts a method parameter and exposes access to type and parameter information.
ParameterNameDiscoverer
Interface to discover parameter names for methods and constructors.
Parameters<P extends Parameter>
Base class to abstract method Parameters.
PartitionException
Partition access exception thrown when a partition-specific operations fails.
Partitions
Cluster topology view.
PartitionSelectorException
Exception thrown when a partition selection fails (slot not covered, no read candidates available).
PatternMessage<K,​V>
Message payload for a subscription to a pattern.
PendingMessage
Value object representing a pending message reported through XPENDING with range/limit.
PendingMessageListOutput<K,​V>
Decodes a list of PendingMessage.
PendingMessages
Value object representing the output of the Redis XPENDING reporting a summary on pending messages.
PendingMessagesOutput<K,​V>
PendingParser
Parser for redis XPENDING command output.
ProtocolKeyword
Interface for protocol keywords providing an encoded representation.
ProtocolVersion
Versions of the native protocol supported by the driver.
PubSubAsyncNodeSelection<K,​V>
Node selection with access to asynchronous executed commands on the set.
PubSubClusterEndpoint<K,​V>  
PubSubCommandHandler<K,​V>
A netty ChannelHandler responsible for writing Redis Pub/Sub commands and reading the response stream from the server.
PubSubEndpoint<K,​V>  
PubSubMessage<K,​V>
Represents a Pub/Sub notification message.
PubSubNodeSelection<K,​V>
Node selection with access to RedisPubSubCommands.
PubSubOutput<K,​V>
One element of the Redis pub/sub stream.
PubSubOutput.Type  
PubSubReactiveNodeSelection<K,​V>
Node selection with access to RedisPubSubCommands.
PushHandler
A handler object that provides access to PushListener.
PushListener
Interface to be implemented by push message listeners that are interested in listening to PushMessage.
PushMessage
Interface representing a push message received from Redis.
PushOutput<K,​V>
Output for push notifications.
Range<T>
Range defines lower and upper boundaries to retrieve items from a sorted set.
Range.Boundary<T>  
ReactiveExecutions<T>
Execution holder for a reactive command to be executed on multiple nodes.
ReadFrom
Defines from which Redis nodes data is read.
ReadFrom.Nodes
Descriptor of nodes that are available for the current read operation.
ReconnectAttemptEvent
Event fired on reconnect attempts.
ReconnectFailedEvent
Event fired on failed reconnect caused either by I/O issues or during connection initialization.
ReconnectionListener
Listener for reconnection events.
RedirectionEventSupport  
RedisAclAsyncCommands<K,​V>
Asynchronous executed commands for the ACL-API.
RedisAclCommands<K,​V>
Synchronous executed commands for the ACL-API.
RedisAclReactiveCommands<K,​V>
Reactive executed commands for the ACL-API.
RedisAdvancedClusterAsyncCommands<K,​V>
Advanced asynchronous and thread-safe Redis Cluster API.
RedisAdvancedClusterAsyncCommandsImpl<K,​V>
An advanced asynchronous and thread-safe API for a Redis Cluster connection.
RedisAdvancedClusterCommands<K,​V>
Advanced synchronous and thread-safe Redis Cluster API.
RedisAdvancedClusterReactiveCommands<K,​V>
Advanced reactive and thread-safe Redis Cluster API.
RedisAdvancedClusterReactiveCommandsImpl<K,​V>
An advanced reactive and thread-safe API to a Redis Cluster connection.
RedisAsyncCommands<K,​V>
A complete asynchronous and thread-safe Redis API with 400+ Methods.
RedisAsyncCommandsImpl<K,​V>
An asynchronous and thread-safe API for a Redis connection.
RedisBusyException
Exception that gets thrown when Redis is busy executing a Lua script with a BUSY error response.
RedisCache<K,​V>
Interface defining common Redis Cache operations.
RedisChannelHandler<K,​V>
Abstract base for every Redis connection.
RedisChannelWriter
Writer for a channel.
RedisClient
A scalable and thread-safe Redis client supporting synchronous, asynchronous and reactive execution models.
RedisClusterAsyncCommands<K,​V>
A complete asynchronous and thread-safe cluster Redis API with 400+ Methods.
RedisClusterClient
A scalable and thread-safe Redis cluster client supporting synchronous, asynchronous and reactive execution models.
RedisClusterCommands<K,​V>
A complete synchronous and thread-safe Redis Cluster API with 400+ Methods.
RedisClusterNode
Representation of a Redis Cluster node.
RedisClusterNode.NodeFlag
Redis Cluster node flags.
RedisClusterPubSubAdapter<K,​V>
Convenience adapter with an empty implementation of all RedisClusterPubSubListener callback methods.
RedisClusterPubSubAsyncCommands<K,​V>
Asynchronous and thread-safe Redis Cluster PubSub API.
RedisClusterPubSubAsyncCommandsImpl<K,​V>
An asynchronous and thread-safe API for a Redis pub/sub connection.
RedisClusterPubSubCommands<K,​V>
Synchronous and thread-safe Redis Cluster PubSub API.
RedisClusterPubSubListener<K,​V>
Interface for Redis Cluster Pub/Sub listeners.
RedisClusterPubSubReactiveCommands<K,​V>
Reactive and thread-safe Redis Cluster PubSub API.
RedisClusterPubSubReactiveCommandsImpl<K,​V>
A reactive and thread-safe API for a Redis pub/sub connection.
RedisClusterPushListener
Interface to be implemented by push message listeners that are interested in listening to PushMessage using Redis Cluster.
RedisClusterReactiveCommands<K,​V>
A complete reactive and thread-safe cluster Redis API with 400+ Methods.
RedisClusterURIUtil
RedisClusterURIUtil is a collection of RedisURI-based utility methods for RedisClusterClient use.
RedisCodec<K,​V>
A RedisCodec encodes keys and values sent to Redis, and decodes keys and values in the command output.
RedisCodecResolver
Strategy interface to resolve a RedisCodec for a CommandMethod.
RedisCommand<K,​V,​T>
A redis command that holds an output, arguments and a state, whether it is completed or not.
RedisCommandExecutionException
Exception for errors states reported by Redis.
RedisCommandFactory
Factory to create Redis Command interface instances.
RedisCommandInterruptedException
Exception thrown when the thread executing a redis command is interrupted.
RedisCommands<K,​V>
A complete synchronous and thread-safe Redis API with 400+ Methods.
RedisCommandTimeoutException
Exception thrown when the command waiting timeout is exceeded.
RedisConnectionException
Exception for connection failures.
RedisConnectionStateAdapter
Convenience adapter with an empty implementation of all RedisConnectionStateListener callback methods.
RedisConnectionStateListener
Simple interface for Redis connection state monitoring.
RedisException
Exception thrown when Redis returns an error message, or when the client fails for any reason.
RedisFuture<V>
A RedisFuture represents the result of an asynchronous computation, extending CompletionStage.
RedisGeoAsyncCommands<K,​V>
Asynchronous executed commands for the Geo-API.
RedisGeoCommands<K,​V>
Synchronous executed commands for the Geo-API.
RedisGeoReactiveCommands<K,​V>
Reactive executed commands for the Geo-API.
RedisHandshakeHandler
Handler to initialize a Redis Connection using a ConnectionInitializer.
RedisHashAsyncCommands<K,​V>
Asynchronous executed commands for Hashes (Key-Value pairs).
RedisHashCommands<K,​V>
Synchronous executed commands for Hashes (Key-Value pairs).
RedisHashReactiveCommands<K,​V>
Reactive executed commands for Hashes (Key-Value pairs).
RedisHLLAsyncCommands<K,​V>
Asynchronous executed commands for HyperLogLog (PF* commands).
RedisHLLCommands<K,​V>
Synchronous executed commands for HyperLogLog (PF* commands).
RedisHLLReactiveCommands<K,​V>
Reactive executed commands for HyperLogLog (PF* commands).
RedisInstance
Represents a redis instance according to the ROLE output.
RedisInstance.Role
Possible Redis instance roles.
RedisKeyAsyncCommands<K,​V>
Asynchronous executed commands for Keys (Key manipulation/querying).
RedisKeyCommands<K,​V>
Synchronous executed commands for Keys (Key manipulation/querying).
RedisKeyReactiveCommands<K,​V>
Reactive executed commands for Keys (Key manipulation/querying).
RedisListAsyncCommands<K,​V>
Asynchronous executed commands for Lists.
RedisListCommands<K,​V>
Synchronous executed commands for Lists.
RedisListReactiveCommands<K,​V>
Reactive executed commands for Lists.
RedisLoadingException
Exception that gets thrown when Redis is loading a dataset into memory and replying with a LOADING error response.
RedisMasterInstance
Represents a upstream (master) instance.
RedisNodeDescription
Description of a single Redis Node.
RedisNoScriptException
Exception that gets thrown when Redis indicates absence of a Lua script referenced by its SHA1 digest with a NOSCRIPT error response.
RedisProtocolException
Exception thrown on Redis protocol failures.
RedisPubSubAdapter<K,​V>
Convenience adapter with an empty implementation of all RedisPubSubListener callback methods.
RedisPubSubAsyncCommands<K,​V>
Asynchronous and thread-safe Redis PubSub API.
RedisPubSubAsyncCommandsImpl<K,​V>
An asynchronous and thread-safe API for a Redis pub/sub connection.
RedisPubSubCommands<K,​V>
Synchronous and thread-safe Redis PubSub API.
RedisPubSubListener<K,​V>
Interface for Redis Pub/Sub listeners.
RedisPubSubReactiveCommands<K,​V>
Asynchronous and thread-safe Redis PubSub API.
RedisPubSubReactiveCommandsImpl<K,​V>
A reactive and thread-safe API for a Redis pub/sub connection.
RedisReactiveCommands<K,​V>
A complete reactive and thread-safe Redis API with 400+ Methods.
RedisReactiveCommandsImpl<K,​V>
A reactive and thread-safe API for a Redis Sentinel connection.
RedisReplicaInstance
Redis replica instance.
RedisReplicaInstance.State
State of the Replica.
RedisScriptingAsyncCommands<K,​V>
Asynchronous executed commands for Scripting.
RedisScriptingCommands<K,​V>
Synchronous executed commands for Scripting.
RedisScriptingReactiveCommands<K,​V>
Reactive executed commands for Scripting.
RedisSentinelAsyncCommands<K,​V>
Asynchronous executed commands for Redis Sentinel.
RedisSentinelAsyncCommandsImpl<K,​V>
An asynchronous and thread-safe API for a Redis Sentinel connection.
RedisSentinelCommands<K,​V>
Synchronous executed commands for Redis Sentinel.
RedisSentinelInstance
Redis sentinel instance.
RedisSentinelReactiveCommands<K,​V>
Reactive executed commands for Redis Sentinel.
RedisSentinelReactiveCommandsImpl<K,​V>
A reactive and thread-safe API for a Redis Sentinel connection.
RedisServerAsyncCommands<K,​V>
Asynchronous executed commands for Server Control.
RedisServerCommands<K,​V>
Synchronous executed commands for Server Control.
RedisServerReactiveCommands<K,​V>
Reactive executed commands for Server Control.
RedisSetAsyncCommands<K,​V>
Asynchronous executed commands for Sets.
RedisSetCommands<K,​V>
Synchronous executed commands for Sets.
RedisSetReactiveCommands<K,​V>
Reactive executed commands for Sets.
RedisSlaveInstance Deprecated.
since 6.0, in favor or RedisReplicaInstance.
RedisSortedSetAsyncCommands<K,​V>
Asynchronous executed commands for Sorted Sets.
RedisSortedSetCommands<K,​V>
Synchronous executed commands for Sorted Sets.
RedisSortedSetReactiveCommands<K,​V>
Reactive executed commands for Sorted Sets.
RedisStateMachine
State machine that decodes redis server responses encoded according to the Unified Request Protocol (RESP).
RedisStreamAsyncCommands<K,​V>
Asynchronous executed commands for Streams.
RedisStreamCommands<K,​V>
Synchronous executed commands for Streams.
RedisStreamReactiveCommands<K,​V>
Reactive executed commands for Streams.
RedisStringAsyncCommands<K,​V>
Asynchronous executed commands for Strings.
RedisStringCommands<K,​V>
Synchronous executed commands for Strings.
RedisStringReactiveCommands<K,​V>
Reactive executed commands for Strings.
RedisTransactionalAsyncCommands<K,​V>
Asynchronous executed commands for Transactions.
RedisTransactionalCommands<K,​V>
Synchronous executed commands for Transactions.
RedisTransactionalReactiveCommands<K,​V>
Reactive executed commands for Transactions.
RedisUpstreamInstance
Represents a upstream instance.
RedisURI
Redis URI.
RedisURI.Builder
Builder for Redis URI.
ReflectionUtils
Simple utility class for working with the reflection API and handling reflection exceptions.
ReflectionUtils.FieldCallback
Callback interface invoked on each field in the hierarchy.
ReflectionUtils.FieldFilter
Callback optionally used to filter fields to be operated on by a field callback.
ReflectionUtils.MethodCallback
Action to take on each method.
ReflectionUtils.MethodFilter
Callback optionally used to filter methods to be operated on by a method callback.
ReplayOutput<K,​V>
Replayable CommandOutput capturing output signals to replay these on a target CommandOutput.
ReplayOutput.BulkString  
ReplayOutput.ErrorBytes  
ReplayOutput.Signal
Encapsulates a replayable decoding signal.
ReplicationPartner
Replication partner providing the host and the replication offset.
ResolvableType
Encapsulates a Java Type, providing access to supertypes, interfaces, and generic parameters along with the ability to ultimately resolve to a Class.
ResolvableType.VariableResolver
Strategy interface used to resolve TypeVariables.
RestoreArgs
Argument list builder for the Redis RESTORE command.
RestoreArgs.Builder
Builder entry points for XAddArgs.
RoleParser
Parser for Redis ROLE command output.
ScanArgs
Argument list builder for the Redis scan commands (SCAN, HSCAN, SSCAN, ZSCAN).
ScanArgs.Builder
Builder entry points for ScanArgs.
ScanCursor
Generic Cursor data structure.
ScanIterator<T>
Scan command support exposed through Iterator.
ScanOutput<K,​V,​T extends ScanCursor>
Cursor handling output.
ScanStream
Scan command support exposed through Flux.
ScoredValue<V>
A scored-value extension to Value.
ScoredValueListOutput<K,​V>
List of values and their associated scores.
ScoredValueOutput<K,​V>
A single ScoredValue.
ScoredValueScanCursor<V>
Cursor providing a list of ScoredValue
ScoredValueScanOutput<K,​V>
ScoredValueScanCursor for scan cursor output.
ScoredValueScanStreamingOutput<K,​V>
Streaming-Output of of values and their associated scores.
ScoredValueStreamingChannel<V>
Streaming API for multiple Keys.
ScoredValueStreamingOutput<K,​V>
Streaming-Output of of values and their associated scores.
ScriptOutputType
A Lua script returns one of the following types: ScriptOutputType.BOOLEAN boolean ScriptOutputType.INTEGER 64-bit integer ScriptOutputType.STATUS status string ScriptOutputType.VALUE value ScriptOutputType.MULTI of these types Redis to Lua conversion table.
SetArgs
Argument list builder for the Redis SET command starting from Redis 2.6.12.
SetArgs.Builder
Builder entry points for SetArgs.
SlotHash
Utility to calculate the slot from a key.
SocketAddressOutput<K,​V>
Output capturing a hostname and port (both string elements) into a SocketAddress.
SocketAddressResolver
Resolves a RedisURI to a SocketAddress.
SocketOptions
Options to configure low-level socket options for the connections kept to Redis servers.
SocketOptions.Builder
Builder for SocketOptions.
SocketOptions.KeepAliveOptions
Extended Keep-Alive options (idle, interval, count).
SocketOptions.KeepAliveOptions.Builder
SortArgs
Argument list builder for the Redis SORT command.
SortArgs.Builder
Builder entry points for SortArgs.
SslConnectionBuilder
Connection builder for SSL connections.
SslOptions
Options to configure SSL options for the connections kept to Redis servers.
SslOptions.Builder
Builder for SslOptions.
SslOptions.Resource
Supplier for a InputStream representing a resource.
SslVerifyMode
Enumeration of SSL/TLS verification modes.
StandardReflectionParameterNameDiscoverer
ParameterNameDiscoverer implementation which uses JDK 8's reflection facilities for introspecting parameter names (based on the "-parameters" compiler flag).
StatefulConnection<K,​V>
A stateful connection providing command dispatching, timeouts and open/close methods.
StatefulRedisClusterConnection<K,​V>
A stateful cluster connection.
StatefulRedisClusterConnectionImpl<K,​V>
A thread-safe connection to a Redis Cluster.
StatefulRedisClusterPubSubConnection<K,​V>
A stateful Pub/Sub connection for Redis Cluster use.
StatefulRedisConnection<K,​V>
A thread-safe connection to a redis server.
StatefulRedisConnectionImpl<K,​V>
A thread-safe connection to a Redis server.
StatefulRedisMasterReplicaConnection<K,​V>
Redis Master-Replica connection.
StatefulRedisMasterSlaveConnection<K,​V> Deprecated.
StatefulRedisPubSubConnection<K,​V>
An asynchronous thread-safe pub/sub connection to a redis server.
StatefulRedisPubSubConnectionImpl<K,​V>
An thread-safe pub/sub connection to a Redis server.
StatefulRedisSentinelConnection<K,​V>
A thread-safe connection to a redis server.
StatefulRedisSentinelConnectionImpl<K,​V>  
StatusOutput<K,​V>
Status message output.
StrAlgoArgs
Argument list builder for the Redis STRALGO command.
StrAlgoArgs.Builder
Builder entry points for StrAlgoArgs.
StrAlgoArgs.By  
StreamingChannel
Marker interface for streaming channels.
StreamingOutput<T>
Implementors of this class support a streaming CommandOutput while the command is still processed.
StreamingOutput.Subscriber<T>
Subscriber to a StreamingOutput.
StreamMessage<K,​V>
A stream message and its id.
StreamMessageListOutput<K,​V>
StreamReadOutput<K,​V>  
StreamScanCursor
Cursor result using the Streaming API.
StringCodec
Optimized String codec.
StringListOutput<K,​V>
List of string output.
StringMatchResult
Result for STRALGO command.
StringMatchResult.MatchedPosition
Match position in each string.
StringMatchResult.Position
Position range.
StringMatchResultOutput<K,​V>
Command output for STRALGO returning StringMatchResult.
StringValueListOutput<K,​V>
List of Value output.
ThreadFactoryProvider
Interface to provide a custom ThreadFactory.
Timeout
Timeout value object to represent a timeout value with its TimeUnit.
TimeoutOptions
Options for command timeouts.
TimeoutOptions.Builder
Builder for TimeoutOptions.
TimeoutOptions.TimeoutSource
Source for the actual timeout to expire a particular RedisCommand.
TimeoutProvider
Provider for command timeout durations.
ToByteBufEncoder<K,​V>
Optimized encoder that encodes keys and values directly on a ByteBuf.
TopologyComparators
Comparators for RedisClusterNode and RedisURI.
TopologyRefreshEvent
Event for initiating a topology refresh.
TraceContext
Marker interface for a context propagation of parent and child spans.
TraceContextProvider
Interface to obtain a TraceContext allowing propagation of Tracer.Span TraceContexts across threads.
TracedCommand<K,​V,​T>
Redis command that is aware of an associated TraceContext.
Tracer
Tracing abstraction to create Tracer.Spans to capture latency and behavior of Redis commands.
Tracer.Span
Used to model the latency of an operation along with tags such as name or the Tracing.Endpoint.
TracerProvider
Interface to obtain a Tracer.
Tracing
Interface declaring methods to trace Redis commands.
Tracing.Endpoint
Value object interface to represent an endpoint.
TrackingArgs
Argument list builder for the Redis CLIENT TRACKING command.
TrackingArgs.Builder
Builder entry points for TrackingArgs.
TransactionalCommand<K,​V,​T>
A wrapper for commands within a MULTI transaction.
TransactionResult
Value interface for a MULTI transaction result.
Transports
Transport infrastructure utility class.
Transports.NativeTransports
Native transport support.
TypeInformation<S>
Interface to access types and resolving generics on the way.
TypeVariableTypeInformation<T>
Special TypeDiscoverer to determine the actual type for a TypeVariable.
UnblockType
Unblock type for CLIENT UNBLOCK command.
UnknownPartitionException
Exception thrown when an unknown partition is requested.
Utf8StringCodec Deprecated.
since 5.2, use StringCodec.UTF8 instead.
Value
Marker annotation to declare a method parameter as value.
Value<V>
A value container object which may or may not contain a non-null value.
ValueListOutput<K,​V>
List of values output.
ValueOutput<K,​V>
Value output.
ValueScanCursor<V>
Cursor providing a list of values.
ValueScanOutput<K,​V>
ValueScanCursor for scan cursor output.
ValueScanStreamingOutput<K,​V>
Streaming API for multiple Values.
ValueSetOutput<K,​V>
Set of value output.
ValueStreamingChannel<V>
Streaming API for multiple Keys.
ValueStreamingOutput<K,​V>
Streaming-Output of Values.
ValueValueListOutput<K,​V>
List of Value wrapped values output.
VoidOutput<K,​V>
Void command output to consume data silently without actually processing it.
XAddArgs
Argument list builder for the Redis XADD command.
XAddArgs.Builder
Builder entry points for XAddArgs.
XAutoClaimArgs<K>
Argument list builder for the Redis XAUTOCLAIM command.
XAutoClaimArgs.Builder
Builder entry points for XAutoClaimArgs.
XClaimArgs
Argument list builder for the Redis XCLAIM command.
XClaimArgs.Builder
Builder entry points for XAddArgs.
XGroupCreateArgs
Argument list builder for the Redis XGROUP CREATE command.
XGroupCreateArgs.Builder
Builder entry points for XGroupCreateArgs.
XPendingArgs<K>
Argument list builder for the Redis XPENDING command.
XPendingArgs.Builder
Builder entry points for XPendingArgs.
XReadArgs
Argument list builder for the Redis XREAD and XREADGROUP commands.
XReadArgs.Builder
Builder entry points for XReadArgs.
XReadArgs.StreamOffset<K>
Value object representing a Stream with its offset.
XTrimArgs
Argument list builder for the Redis XTRIM command.
XTrimArgs.Builder
Builder entry points for XTrimArgs.
ZAddArgs
Argument list builder for the improved Redis ZADD command starting from Redis 3.0.2.
ZAddArgs.Builder
Builder entry points for ScanArgs.
ZAggregateArgs
Argument list builder for the Redis ZUNION, ZUNIONSTORE, ZINTER and ZINTERSTORE commands.
ZAggregateArgs.Builder
Builder entry points for ScanArgs.
ZStoreArgs
Argument list builder for the Redis ZUNIONSTORE and ZINTERSTORE commands.
ZStoreArgs.Builder
Builder entry points for ScanArgs.