java.lang.Object

org.redisson.Redisson

All Implemented Interfaces:: RedissonClient

public final class Redisson extends Object implements RedissonClient

Main infrastructure class allows to get access to all Redisson objects on top of Redis server.

Author:: Nikita Koksharov

Method Summary

Modifier and Type

Method

Description

static RedissonClient

create()

Create sync/async Redisson instance with default config

static RedissonClient

create(Config config)

Create sync/async Redisson instance with provided config

RBatch

createBatch()

Creates batch object which could be executed later with collected group of commands in pipeline mode.

RBatch

createBatch(BatchOptions options)

Creates batch object which could be executed later with collected group of commands in pipeline mode.

static RedissonReactiveClient

createReactive()

Deprecated.

static RedissonReactiveClient

createReactive(Config config)

Deprecated.

static RedissonRxClient

createRx()

Deprecated.

static RedissonRxClient

createRx(Config config)

Deprecated.

RTransaction

createTransaction(TransactionOptions options)

Creates transaction with READ_COMMITTED isolation level.

RAtomicDouble

getAtomicDouble(String name)

Returns atomicDouble instance by name.

RAtomicDouble

getAtomicDouble(CommonOptions options)

Returns atomicDouble instance with specified options.

RAtomicLong

getAtomicLong(String name)

Returns atomicLong instance by name.

RAtomicLong

getAtomicLong(CommonOptions options)

Returns atomicLong instance with specified options.

RBinaryStream

getBinaryStream(String name)

Returns binary stream holder instance by name

RBinaryStream

getBinaryStream(CommonOptions options)

Returns binary stream holder instance with specified options.

RBitSet

getBitSet(String name)

Returns bitSet instance by name.

RBitSet

getBitSet(CommonOptions options)

Returns bitSet instance with specified options.

<V> RBlockingDeque<V>

getBlockingDeque(String name)

Returns unbounded blocking deque instance by name.

<V> RBlockingDeque<V>

getBlockingDeque(String name, Codec codec)

Returns unbounded blocking deque instance by name using provided codec for deque objects.

<V> RBlockingDeque<V>

getBlockingDeque(PlainOptions options)

Returns unbounded blocking deque instance with specified options.

<V> RBlockingQueue<V>

getBlockingQueue(String name)

Returns unbounded blocking queue instance by name.

<V> RBlockingQueue<V>

getBlockingQueue(String name, Codec codec)

Returns unbounded blocking queue instance by name using provided codec for queue objects.

<V> RBlockingQueue<V>

getBlockingQueue(PlainOptions options)

Returns unbounded blocking queue instance with specified options.

<V> RBloomFilter<V>

getBloomFilter(String name)

Returns bloom filter instance by name.

<V> RBloomFilter<V>

getBloomFilter(String name, Codec codec)

Returns bloom filter instance by name using provided codec for objects.

<V> RBloomFilter<V>

getBloomFilter(PlainOptions options)

Returns bloom filter instance with specified options.

<V> RBoundedBlockingQueue<V>

getBoundedBlockingQueue(String name)

Returns bounded blocking queue instance by name.

<V> RBoundedBlockingQueue<V>

getBoundedBlockingQueue(String name, Codec codec)

Returns bounded blocking queue instance by name using provided codec for queue objects.

<V> RBoundedBlockingQueue<V>

getBoundedBlockingQueue(PlainOptions options)

Returns bounded blocking queue instance with specified options.

<V> RBucket<V>

getBucket(String name)

Returns object holder instance by name.

<V> RBucket<V>

getBucket(String name, Codec codec)

Returns object holder instance by name using provided codec for object.

<V> RBucket<V>

getBucket(PlainOptions options)

Returns object holder instance with specified options.

RBuckets

getBuckets()

Returns interface for mass operations with Bucket objects.

RBuckets

getBuckets(OptionalOptions options)

Returns API for mass operations over Bucket objects with specified options.

RBuckets

getBuckets(Codec codec)

Returns interface for mass operations with Bucket objects using provided codec for object.

ClusterNodesGroup

getClusterNodesGroup()

CommandAsyncExecutor

getCommandExecutor()

Config

getConfig()

Allows to get configuration provided during Redisson instance creation.

ConnectionManager

getConnectionManager()

RCountDownLatch

getCountDownLatch(String name)

Returns countDownLatch instance by name.

RCountDownLatch

getCountDownLatch(CommonOptions options)

Returns countDownLatch instance with specified options.

<V> RDelayedQueue<V>

getDelayedQueue(RQueue<V> destinationQueue)

Returns unbounded delayed queue instance by name.

<V> RDeque<V>

getDeque(String name)

Returns unbounded deque instance by name.

<V> RDeque<V>

getDeque(String name, Codec codec)

Returns unbounded deque instance by name using provided codec for deque objects.

<V> RDeque<V>

getDeque(PlainOptions options)

Returns unbounded deque instance with specified options.

RDoubleAdder

getDoubleAdder(String name)

Returns DoubleAdder instances by name.

RDoubleAdder

getDoubleAdder(CommonOptions options)

Returns DoubleAdder instances with specified options.

EvictionScheduler

getEvictionScheduler()

RScheduledExecutorService

getExecutorService(String name)

Returns ScheduledExecutorService by name

RScheduledExecutorService

getExecutorService(String name, ExecutorOptions options)

Use RedissonClient.getExecutorService(org.redisson.api.options.ExecutorOptions) instead

RScheduledExecutorService

getExecutorService(String name, Codec codec)

Returns ScheduledExecutorService by name using provided codec for task, response and request serialization

RScheduledExecutorService

getExecutorService(String name, Codec codec, ExecutorOptions options)

Use RedissonClient.getExecutorService(org.redisson.api.options.ExecutorOptions) instead

RScheduledExecutorService

getExecutorService(ExecutorOptions options)

Returns ScheduledExecutorService with defined options

RLock

getFairLock(String name)

Returns Lock instance by name.

RLock

getFairLock(CommonOptions options)

Returns Lock instance with specified options.

RFencedLock

getFencedLock(String name)

Returns Fenced Lock instance by name.

RFencedLock

getFencedLock(CommonOptions options)

Returns Fenced Lock instance with specified options..

RFunction

getFunction()

Returns API for Redis Function feature

RFunction

getFunction(OptionalOptions options)

Returns interface for Redis Function feature with specified options.

RFunction

getFunction(Codec codec)

Returns API for Redis Function feature using provided codec

<V> RGeo<V>

getGeo(String name)

Returns geospatial items holder instance by name.

<V> RGeo<V>

getGeo(String name, Codec codec)

Returns geospatial items holder instance by name using provided codec for geospatial members.

<V> RGeo<V>

getGeo(PlainOptions options)

Returns geospatial items holder instance with specified options.

<V> RHyperLogLog<V>

getHyperLogLog(String name)

Returns HyperLogLog instance by name.

<V> RHyperLogLog<V>

getHyperLogLog(String name, Codec codec)

Returns HyperLogLog instance by name using provided codec for hll objects.

<V> RHyperLogLog<V>

getHyperLogLog(PlainOptions options)

Returns HyperLogLog instance with specified options.

String

getId()

Returns id of this Redisson instance

RIdGenerator

getIdGenerator(String name)

Returns id generator instance by name.

RIdGenerator

getIdGenerator(CommonOptions options)

Returns id generator instance with specified options.

<V> RJsonBucket<V>

getJsonBucket(String name, JsonCodec<V> codec)

Returns JSON data holder instance by name using provided codec.

<V> RJsonBucket<V>

getJsonBucket(JsonBucketOptions<V> options)

Returns JSON data holder instance with specified options.

RKeys

getKeys()

Returns interface with methods for Redis keys.

RKeys

getKeys(KeysOptions options)

Returns interface for operations over Redis keys with specified options.

RLexSortedSet

getLexSortedSet(String name)

Returns String based Redis Sorted Set instance by name.

RLexSortedSet

getLexSortedSet(CommonOptions options)

Returns String based Redis Sorted Set instance with specified options.

<V> RList<V>

getList(String name)

Returns list instance by name.

<V> RList<V>

getList(String name, Codec codec)

Returns list instance by name using provided codec for list objects.

<V> RList<V>

getList(PlainOptions options)

Returns list instance with specified options.

<K, V> RListMultimap<K,V>

getListMultimap(String name)

Returns List based Multimap instance by name.

<K, V> RListMultimap<K,V>

getListMultimap(String name, Codec codec)

Returns List based Multimap instance by name using provided codec for both map keys and values.

<K, V> RListMultimap<K,V>

getListMultimap(PlainOptions options)

Returns List based Multimap instance with specified options.

<K, V> RListMultimapCache<K,V>

getListMultimapCache(String name)

Returns List based Multimap instance by name.

<K, V> RListMultimapCache<K,V>

getListMultimapCache(String name, Codec codec)

Returns List based Multimap instance by name using provided codec for both map keys and values.

<K, V> RListMultimapCache<K,V>

getListMultimapCache(PlainOptions options)

Returns List based Multimap instance by name.

RLiveObjectService

getLiveObjectService()

Returns Live Object Service which is used to store Java objects

RLiveObjectService

getLiveObjectService(LiveObjectOptions options)

Returns Live Object Service which is used to store Java objects with specified options.

<K, V> RLocalCachedMap<K,V>

getLocalCachedMap(String name, LocalCachedMapOptions<K,V> options)

Returns local cached map instance by name.

<K, V> RLocalCachedMap<K,V>

getLocalCachedMap(String name, Codec codec, LocalCachedMapOptions<K,V> options)

Returns local cached map instance by name using provided codec.

<K, V> RLocalCachedMap<K,V>

getLocalCachedMap(LocalCachedMapOptions<K,V> options)

Returns local cached map instance with specified options.

RLock

getLock(String name)

Returns Lock instance by name.

RLock

getLock(CommonOptions options)

Returns Lock instance with specified options.

RLongAdder

getLongAdder(String name)

Returns LongAdder instances by name.

RLongAdder

getLongAdder(CommonOptions options)

Returns LongAdder instances with specified options.

<K, V> RMap<K,V>

getMap(String name)

Returns map instance by name.

<K, V> RMap<K,V>

getMap(String name, MapOptions<K,V> options)

Returns map instance by name.

<K, V> RMap<K,V>

getMap(String name, Codec codec)

Returns map instance by name using provided codec for both map keys and values.

<K, V> RMap<K,V>

getMap(String name, Codec codec, MapOptions<K,V> options)

Returns map instance by name using provided codec for both map keys and values.

<K, V> RMap<K,V>

getMap(MapOptions<K,V> options)

Returns map instance by name.

<K, V> RMapCache<K,V>

getMapCache(String name)

Returns map-based cache instance by name.

<K, V> RMapCache<K,V>

getMapCache(String name, MapCacheOptions<K,V> options)

Returns map-based cache instance by name.

<K, V> RMapCache<K,V>

getMapCache(String name, Codec codec)

Returns map-based cache instance by name using provided codec for both cache keys and values.

<K, V> RMapCache<K,V>

getMapCache(String name, Codec codec, MapCacheOptions<K,V> options)

Returns map-based cache instance by name using provided codec for both cache keys and values.

<K, V> RMapCache<K,V>

getMapCache(MapCacheOptions<K,V> options)

Returns map-based cache instance with specified options.

RLock

getMultiLock(RLock... locks)

Returns MultiLock instance associated with specified locks

NodesGroup<Node>

getNodesGroup()

RPatternTopic

getPatternTopic(String pattern)

Returns topic instance satisfies by pattern name.

RPatternTopic

getPatternTopic(String pattern, Codec codec)

Returns topic instance satisfies by pattern name using provided codec for messages.

RPatternTopic

getPatternTopic(PatternTopicOptions options)

Returns topic instance satisfies pattern name and specified options..

RPermitExpirableSemaphore

getPermitExpirableSemaphore(String name)

Returns semaphore instance by name.

RPermitExpirableSemaphore

getPermitExpirableSemaphore(CommonOptions options)

Returns semaphore instance with specified options.

<V> RPriorityBlockingDeque<V>

getPriorityBlockingDeque(String name)

Returns unbounded priority blocking deque instance by name.

<V> RPriorityBlockingDeque<V>

getPriorityBlockingDeque(String name, Codec codec)

Returns unbounded priority blocking deque instance by name using provided codec for queue objects.

<V> RPriorityBlockingDeque<V>

getPriorityBlockingDeque(PlainOptions options)

Returns unbounded priority blocking deque instance with specified options.

<V> RPriorityBlockingQueue<V>

getPriorityBlockingQueue(String name)

Returns unbounded priority blocking queue instance by name.

<V> RPriorityBlockingQueue<V>

getPriorityBlockingQueue(String name, Codec codec)

Returns unbounded priority blocking queue instance by name using provided codec for queue objects.

<V> RPriorityBlockingQueue<V>

getPriorityBlockingQueue(PlainOptions options)

Returns unbounded priority blocking queue instance with specified options.

<V> RPriorityDeque<V>

getPriorityDeque(String name)

Returns priority unbounded deque instance by name.

<V> RPriorityDeque<V>

getPriorityDeque(String name, Codec codec)

Returns priority unbounded deque instance by name using provided codec for queue objects.

<V> RPriorityDeque<V>

getPriorityDeque(PlainOptions options)

Returns priority unbounded deque instance with specified options.

<V> RPriorityQueue<V>

getPriorityQueue(String name)

Returns priority unbounded queue instance by name.

<V> RPriorityQueue<V>

getPriorityQueue(String name, Codec codec)

Returns priority unbounded queue instance by name using provided codec for queue objects.

<V> RPriorityQueue<V>

getPriorityQueue(PlainOptions options)

<V> RQueue<V>

getQueue(String name)

Returns unbounded queue instance by name.

<V> RQueue<V>

getQueue(String name, Codec codec)

Returns unbounded queue instance by name using provided codec for queue objects.

<V> RQueue<V>

getQueue(PlainOptions options)

Returns unbounded queue instance with specified options.

RRateLimiter

getRateLimiter(String name)

Returns rate limiter instance by name

RRateLimiter

getRateLimiter(CommonOptions options)

Returns rate limiter instance with specified options.

RReadWriteLock

getReadWriteLock(String name)

Returns ReadWriteLock instance by name.

RReadWriteLock

getReadWriteLock(CommonOptions options)

Returns ReadWriteLock instance with specified options.

<T extends BaseRedisNodes> T

getRedisNodes(RedisNodes<T> nodes)

Returns API to manage Redis nodes

RLock

getRedLock(RLock... locks)

RReliableTopic

getReliableTopic(String name)

Returns reliable topic instance by name.

RReliableTopic

getReliableTopic(String name, Codec codec)

Returns reliable topic instance by name using provided codec for messages.

RReliableTopic

getReliableTopic(PlainOptions options)

Returns reliable topic instance with specified options.

RRemoteService

getRemoteService()

Returns object for remote operations prefixed with the default name (redisson_remote_service)

RRemoteService

getRemoteService(String name)

Returns object for remote operations prefixed with the specified name

RRemoteService

getRemoteService(String name, Codec codec)

Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.

RRemoteService

getRemoteService(PlainOptions options)

Returns object for remote operations prefixed with specified options.

RRemoteService

getRemoteService(Codec codec)

Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.

<V> RRingBuffer<V>

getRingBuffer(String name)

Returns RingBuffer based queue.

<V> RRingBuffer<V>

getRingBuffer(String name, Codec codec)

Returns RingBuffer based queue.

<V> RRingBuffer<V>

getRingBuffer(PlainOptions options)

Returns RingBuffer based queue instance with specified options.

<V> RScoredSortedSet<V>

getScoredSortedSet(String name)

Returns Redis Sorted Set instance by name.

<V> RScoredSortedSet<V>

getScoredSortedSet(String name, Codec codec)

Returns Redis Sorted Set instance by name using provided codec for sorted set objects.

<V> RScoredSortedSet<V>

getScoredSortedSet(PlainOptions options)

Returns Redis Sorted Set instance with specified options.

RScript

getScript()

Returns script operations object

RScript

getScript(OptionalOptions options)

Returns script operations object with specified options.

RScript

getScript(Codec codec)

Returns script operations object using provided codec.

RSearch

getSearch()

Returns API for RediSearch module

RSearch

getSearch(OptionalOptions options)

Returns API for RediSearch module with specified options.

RSearch

getSearch(Codec codec)

Returns API for RediSearch module using defined codec for attribute values.

RSemaphore

getSemaphore(String name)

Returns semaphore instance by name

RSemaphore

getSemaphore(CommonOptions options)

Returns semaphore instance with specified options.

ServiceManager

getServiceManager()

<V> RSet<V>

getSet(String name)

Returns set instance by name.

<V> RSet<V>

getSet(String name, Codec codec)

Returns set instance by name using provided codec for set objects.

<V> RSet<V>

getSet(PlainOptions options)

Returns set instance with specified options.

<V> RSetCache<V>

getSetCache(String name)

Returns set-based cache instance by name.

<V> RSetCache<V>

getSetCache(String name, Codec codec)

Returns set-based cache instance by name.

<V> RSetCache<V>

getSetCache(PlainOptions options)

Returns set-based cache instance with specified options.

<K, V> RSetMultimap<K,V>

getSetMultimap(String name)

Returns Set based Multimap instance by name.

<K, V> RSetMultimap<K,V>

getSetMultimap(String name, Codec codec)

Returns Set based Multimap instance by name using provided codec for both map keys and values.

<K, V> RSetMultimap<K,V>

getSetMultimap(PlainOptions options)

Returns Set based Multimap instance with specified options.

<K, V> RSetMultimapCache<K,V>

getSetMultimapCache(String name)

Returns Set based Multimap instance by name.

<K, V> RSetMultimapCache<K,V>

getSetMultimapCache(String name, Codec codec)

Returns Set based Multimap instance by name using provided codec for both map keys and values.

<K, V> RSetMultimapCache<K,V>

getSetMultimapCache(PlainOptions options)

Returns Set based Multimap instance with specified options.

RShardedTopic

getShardedTopic(String name)

Returns Sharded Topic instance by name.

RShardedTopic

getShardedTopic(String name, Codec codec)

Returns Sharded Topic instance by name using provided codec for messages.

RShardedTopic

getShardedTopic(PlainOptions options)

Returns Sharded Topic instance with specified options.

<V> RSortedSet<V>

getSortedSet(String name)

Returns sorted set instance by name.

<V> RSortedSet<V>

getSortedSet(String name, Codec codec)

Returns sorted set instance by name using provided codec for sorted set objects.

<V> RSortedSet<V>

getSortedSet(PlainOptions options)

Returns sorted set instance with specified options.

RLock

getSpinLock(String name)

Returns Spin lock instance by name.

RLock

getSpinLock(String name, LockOptions.BackOff backOff)

Returns Spin lock instance by name with specified back off options.

<K, V> RStream<K,V>

getStream(String name)

Returns stream instance by name

<K, V> RStream<K,V>

getStream(String name, Codec codec)

Returns stream instance by name using provided codec for entries.

<K, V> RStream<K,V>

getStream(PlainOptions options)

Returns time-series instance with specified options.

<V, L> RTimeSeries<V,L>

getTimeSeries(String name)

Returns time-series instance by name

<V, L> RTimeSeries<V,L>

getTimeSeries(String name, Codec codec)

Returns time-series instance by name using provided codec for values.

<V, L> RTimeSeries<V,L>

getTimeSeries(PlainOptions options)

Returns time-series instance with specified options.

RTopic

getTopic(String name)

Returns topic instance by name.

RTopic

getTopic(String name, Codec codec)

Returns topic instance by name using provided codec for messages.

RTopic

getTopic(PlainOptions options)

Returns topic instance with specified options.

<V> RTransferQueue<V>

getTransferQueue(String name)

Returns transfer queue instance by name.

<V> RTransferQueue<V>

getTransferQueue(String name, Codec codec)

Returns transfer queue instance by name using provided codec for queue objects.

<V> RTransferQueue<V>

getTransferQueue(PlainOptions options)

Returns transfer queue instance with specified options.

boolean

isShutdown()

Returns true if this Redisson instance has been shut down.

boolean

isShuttingDown()

Returns true if this Redisson instance was started to be shutdown or was shutdown RedissonClient.isShutdown() already.

RedissonReactiveClient

reactive()

Returns Reactive Redisson instance

RedissonRxClient

rxJava()

Returns RxJava Redisson instance

void

shutdown()

Shutdown Redisson instance but NOT Redis server This equates to invoke shutdown(0, 2, TimeUnit.SECONDS);

void

shutdown(long quietPeriod, long timeout, TimeUnit unit)

Shuts down Redisson instance but NOT Redis server Shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down.

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

Method Details
- getEvictionScheduler
  
  public EvictionScheduler getEvictionScheduler()
- getCommandExecutor
  
  public CommandAsyncExecutor getCommandExecutor()
- getConnectionManager
  
  public ConnectionManager getConnectionManager()
- getServiceManager
  
  public ServiceManager getServiceManager()
- create
  
  public static RedissonClient create()
  
  Create sync/async Redisson instance with default config
  
  Returns:
  
  Redisson instance
- create
  
  public static RedissonClient create(Config config)
  
  Create sync/async Redisson instance with provided config
  
  Parameters:
  
  config - for Redisson
  
  Returns:
  
  Redisson instance
- createRx
  
  @Deprecated public static RedissonRxClient createRx()
  
  Deprecated.
- createRx
  
  @Deprecated public static RedissonRxClient createRx(Config config)
  
  Deprecated.
- rxJava
  
  public RedissonRxClient rxJava()
  
  Description copied from interface: RedissonClient
  
  Returns RxJava Redisson instance
  
  Specified by:
  
  rxJava in interface RedissonClient
  
  Returns:
  
  redisson instance
- createReactive
  
  @Deprecated public static RedissonReactiveClient createReactive()
  
  Deprecated.
- createReactive
  
  @Deprecated public static RedissonReactiveClient createReactive(Config config)
  
  Deprecated.
- reactive
  
  public RedissonReactiveClient reactive()
  
  Description copied from interface: RedissonClient
  
  Returns Reactive Redisson instance
  
  Specified by:
  
  reactive in interface RedissonClient
  
  Returns:
  
  redisson instance
- getTimeSeries
  
  public <V, L> RTimeSeries<V,L> getTimeSeries(String name)
  
  Description copied from interface: RedissonClient
  
  Returns time-series instance by name
  
  Specified by:
  
  getTimeSeries in interface RedissonClient
  
  Type Parameters:
  
  V - value type
  
  L - label type
  
  Parameters:
  
  name - name of instance
  
  Returns:
  
  RTimeSeries object
- getTimeSeries
  
  public <V, L> RTimeSeries<V,L> getTimeSeries(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns time-series instance by name using provided codec for values.
  
  Specified by:
  
  getTimeSeries in interface RedissonClient
  
  Type Parameters:
  
  V - value type
  
  L - label type
  
  Parameters:
  
  name - name of instance
  
  codec - codec for values
  
  Returns:
  
  RTimeSeries object
- getTimeSeries
  
  public <V, L> RTimeSeries<V,L> getTimeSeries(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns time-series instance with specified options.
  
  Specified by:
  
  getTimeSeries in interface RedissonClient
  
  Type Parameters:
  
  V - value type
  
  L - label type
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  RTimeSeries object
- getStream
  
  public <K, V> RStream<K,V> getStream(String name)
  
  Description copied from interface: RedissonClient
  
  Returns stream instance by name
  Requires Redis 5.0.0 and higher.
  
  Specified by:
  
  getStream in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - of stream
  
  Returns:
  
  RStream object
- getStream
  
  public <K, V> RStream<K,V> getStream(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns stream instance by name using provided codec for entries.
  Requires Redis 5.0.0 and higher.
  
  Specified by:
  
  getStream in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of stream
  
  codec - codec for entry
  
  Returns:
  
  RStream object
- getStream
  
  public <K, V> RStream<K,V> getStream(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns time-series instance with specified options.
  Requires Redis 5.0.0 and higher.
  
  Specified by:
  
  getStream in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  RStream object
- getSearch
  
  public RSearch getSearch()
  
  Description copied from interface: RedissonClient
  
  Returns API for RediSearch module
  
  Specified by:
  
  getSearch in interface RedissonClient
  
  Returns:
  
  RSearch object
- getSearch
  
  public RSearch getSearch(Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns API for RediSearch module using defined codec for attribute values.
  
  Specified by:
  
  getSearch in interface RedissonClient
  
  Parameters:
  
  codec - codec for entry
  
  Returns:
  
  RSearch object
- getSearch
  
  public RSearch getSearch(OptionalOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns API for RediSearch module with specified options.
  
  Specified by:
  
  getSearch in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  RSearch object
- getBinaryStream
  
  public RBinaryStream getBinaryStream(String name)
  
  Description copied from interface: RedissonClient
  
  Returns binary stream holder instance by name
  
  Specified by:
  
  getBinaryStream in interface RedissonClient
  
  Parameters:
  
  name - of binary stream
  
  Returns:
  
  BinaryStream object
- getBinaryStream
  
  public RBinaryStream getBinaryStream(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns binary stream holder instance with specified options.
  
  Specified by:
  
  getBinaryStream in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  BinaryStream object
- getGeo
  
  public <V> RGeo<V> getGeo(String name)
  
  Description copied from interface: RedissonClient
  
  Returns geospatial items holder instance by name.
  
  Specified by:
  
  getGeo in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Geo object
- getGeo
  
  public <V> RGeo<V> getGeo(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns geospatial items holder instance by name using provided codec for geospatial members.
  
  Specified by:
  
  getGeo in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for value
  
  Returns:
  
  Geo object
- getGeo
  
  public <V> RGeo<V> getGeo(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns geospatial items holder instance with specified options.
  
  Specified by:
  
  getGeo in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Geo object
- getBucket
  
  public <V> RBucket<V> getBucket(String name)
  
  Description copied from interface: RedissonClient
  
  Returns object holder instance by name.
  
  Specified by:
  
  getBucket in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Bucket object
- getRateLimiter
  
  public RRateLimiter getRateLimiter(String name)
  
  Description copied from interface: RedissonClient
  
  Returns rate limiter instance by name
  
  Specified by:
  
  getRateLimiter in interface RedissonClient
  
  Parameters:
  
  name - of rate limiter
  
  Returns:
  
  RateLimiter object
- getRateLimiter
  
  public RRateLimiter getRateLimiter(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns rate limiter instance with specified options.
  
  Specified by:
  
  getRateLimiter in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  RateLimiter object
- getBucket
  
  public <V> RBucket<V> getBucket(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns object holder instance by name using provided codec for object.
  
  Specified by:
  
  getBucket in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  Bucket object
- getBucket
  
  public <V> RBucket<V> getBucket(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns object holder instance with specified options.
  
  Specified by:
  
  getBucket in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Bucket object
- getBuckets
  
  public RBuckets getBuckets()
  
  Description copied from interface: RedissonClient
  
  Returns interface for mass operations with Bucket objects.
  
  Specified by:
  
  getBuckets in interface RedissonClient
  
  Returns:
  
  Buckets object
- getBuckets
  
  public RBuckets getBuckets(Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns interface for mass operations with Bucket objects using provided codec for object.
  
  Specified by:
  
  getBuckets in interface RedissonClient
  
  Parameters:
  
  codec - codec for bucket objects
  
  Returns:
  
  Buckets object
- getBuckets
  
  public RBuckets getBuckets(OptionalOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns API for mass operations over Bucket objects with specified options.
  
  Specified by:
  
  getBuckets in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Buckets object
- getJsonBucket
  
  public <V> RJsonBucket<V> getJsonBucket(String name, JsonCodec<V> codec)
  
  Description copied from interface: RedissonClient
  
  Returns JSON data holder instance by name using provided codec.
  
  Specified by:
  
  getJsonBucket in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  JsonBucket object
- getJsonBucket
  
  public <V> RJsonBucket<V> getJsonBucket(JsonBucketOptions<V> options)
  
  Description copied from interface: RedissonClient
  
  Returns JSON data holder instance with specified options.
  
  Specified by:
  
  getJsonBucket in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  JsonBucket object
- getHyperLogLog
  
  public <V> RHyperLogLog<V> getHyperLogLog(String name)
  
  Description copied from interface: RedissonClient
  
  Returns HyperLogLog instance by name.
  
  Specified by:
  
  getHyperLogLog in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  HyperLogLog object
- getHyperLogLog
  
  public <V> RHyperLogLog<V> getHyperLogLog(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns HyperLogLog instance by name using provided codec for hll objects.
  
  Specified by:
  
  getHyperLogLog in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  HyperLogLog object
- getHyperLogLog
  
  public <V> RHyperLogLog<V> getHyperLogLog(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns HyperLogLog instance with specified options.
  
  Specified by:
  
  getHyperLogLog in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  HyperLogLog object
- getList
  
  public <V> RList<V> getList(String name)
  
  Description copied from interface: RedissonClient
  
  Returns list instance by name.
  
  Specified by:
  
  getList in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  List object
- getList
  
  public <V> RList<V> getList(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns list instance by name using provided codec for list objects.
  
  Specified by:
  
  getList in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  List object
- getList
  
  public <V> RList<V> getList(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns list instance with specified options.
  
  Specified by:
  
  getList in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  List object
- getListMultimap
  
  public <K, V> RListMultimap<K,V> getListMultimap(String name)
  
  Description copied from interface: RedissonClient
  
  Returns List based Multimap instance by name.
  
  Specified by:
  
  getListMultimap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  ListMultimap object
- getListMultimap
  
  public <K, V> RListMultimap<K,V> getListMultimap(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns List based Multimap instance by name using provided codec for both map keys and values.
  
  Specified by:
  
  getListMultimap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for keys and values
  
  Returns:
  
  ListMultimap object
- getListMultimap
  
  public <K, V> RListMultimap<K,V> getListMultimap(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns List based Multimap instance with specified options.
  
  Specified by:
  
  getListMultimap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  ListMultimap object
- getLocalCachedMap
  
  public <K, V> RLocalCachedMap<K,V> getLocalCachedMap(String name, LocalCachedMapOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns local cached map instance by name. Configured by parameters of options-object.
  
  Specified by:
  
  getLocalCachedMap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  options - local map options
  
  Returns:
  
  LocalCachedMap object
- getLocalCachedMap
  
  public <K, V> RLocalCachedMap<K,V> getLocalCachedMap(String name, Codec codec, LocalCachedMapOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns local cached map instance by name using provided codec. Configured by parameters of options-object.
  
  Specified by:
  
  getLocalCachedMap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for keys and values
  
  options - local map options
  
  Returns:
  
  LocalCachedMap object
- getLocalCachedMap
  
  public <K, V> RLocalCachedMap<K,V> getLocalCachedMap(LocalCachedMapOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns local cached map instance with specified options.
  
  Specified by:
  
  getLocalCachedMap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  LocalCachedMap object
- getMap
  
  public <K, V> RMap<K,V> getMap(String name)
  
  Description copied from interface: RedissonClient
  
  Returns map instance by name.
  
  Specified by:
  
  getMap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Map object
- getMap
  
  public <K, V> RMap<K,V> getMap(String name, MapOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns map instance by name.
  
  Specified by:
  
  getMap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  options - map options
  
  Returns:
  
  Map object
- getMap
  
  public <K, V> RMap<K,V> getMap(MapOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns map instance by name.
  
  Specified by:
  
  getMap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Map object
- getSetMultimap
  
  public <K, V> RSetMultimap<K,V> getSetMultimap(String name)
  
  Description copied from interface: RedissonClient
  
  Returns Set based Multimap instance by name.
  
  Specified by:
  
  getSetMultimap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  SetMultimap object
- getSetMultimapCache
  
  public <K, V> RSetMultimapCache<K,V> getSetMultimapCache(String name)
  
  Description copied from interface: RedissonClient
  
  Returns Set based Multimap instance by name. Supports key-entry eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSetMultimap(String).
  
  Specified by:
  
  getSetMultimapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  SetMultimapCache object
- getSetMultimapCache
  
  public <K, V> RSetMultimapCache<K,V> getSetMultimapCache(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns Set based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSetMultimap(String, Codec).
  
  Specified by:
  
  getSetMultimapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for keys and values
  
  Returns:
  
  SetMultimapCache object
- getSetMultimapCache
  
  public <K, V> RSetMultimapCache<K,V> getSetMultimapCache(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns Set based Multimap instance with specified options. Supports key-entry eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSetMultimap(PlainOptions).
  
  Specified by:
  
  getSetMultimapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  SetMultimapCache object
- getListMultimapCache
  
  public <K, V> RListMultimapCache<K,V> getListMultimapCache(String name)
  
  Description copied from interface: RedissonClient
  
  Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSetMultimap(String).
  
  Specified by:
  
  getListMultimapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  ListMultimapCache object
- getListMultimapCache
  
  public <K, V> RListMultimapCache<K,V> getListMultimapCache(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns List based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSetMultimap(String, Codec).
  
  Specified by:
  
  getListMultimapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for keys and values
  
  Returns:
  
  ListMultimapCache object
- getListMultimapCache
  
  public <K, V> RListMultimapCache<K,V> getListMultimapCache(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSetMultimap(String).
  
  Specified by:
  
  getListMultimapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  ListMultimapCache object
- getSetMultimap
  
  public <K, V> RSetMultimap<K,V> getSetMultimap(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns Set based Multimap instance by name using provided codec for both map keys and values.
  
  Specified by:
  
  getSetMultimap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for keys and values
  
  Returns:
  
  SetMultimap object
- getSetMultimap
  
  public <K, V> RSetMultimap<K,V> getSetMultimap(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns Set based Multimap instance with specified options.
  
  Specified by:
  
  getSetMultimap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  SetMultimap object
- getSetCache
  
  public <V> RSetCache<V> getSetCache(String name)
  
  Description copied from interface: RedissonClient
  
  Returns set-based cache instance by name. Supports value eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSet(String, Codec).
  
  Specified by:
  
  getSetCache in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  SetCache object
- getSetCache
  
  public <V> RSetCache<V> getSetCache(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns set-based cache instance by name. Supports value eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSet(String, Codec).
  
  Specified by:
  
  getSetCache in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  SetCache object
- getSetCache
  
  public <V> RSetCache<V> getSetCache(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns set-based cache instance with specified options. Supports value eviction with a given TTL value.
  If eviction is not required then it's better to use regular map RedissonClient.getSet(PlainOptions).
  
  Specified by:
  
  getSetCache in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  SetCache object
- getMapCache
  
  public <K, V> RMapCache<K,V> getMapCache(String name)
  
  Description copied from interface: RedissonClient
  
  Returns map-based cache instance by name. Supports entry eviction with a given MaxIdleTime and TTL settings.
  If eviction is not required then it's better to use regular map RedissonClient.getMap(String).
  
  Specified by:
  
  getMapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  MapCache object
- getMapCache
  
  public <K, V> RMapCache<K,V> getMapCache(String name, MapCacheOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns map-based cache instance by name. Supports entry eviction with a given MaxIdleTime and TTL settings.
  If eviction is not required then it's better to use regular map RedissonClient.getMap(String).
  
  Specified by:
  
  getMapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  options - map options
  
  Returns:
  
  MapCache object
- getMapCache
  
  public <K, V> RMapCache<K,V> getMapCache(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given MaxIdleTime and TTL settings.
  If eviction is not required then it's better to use regular map RedissonClient.getMap(String, Codec).
  
  Specified by:
  
  getMapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - object name
  
  codec - codec for keys and values
  
  Returns:
  
  MapCache object
- getMapCache
  
  public <K, V> RMapCache<K,V> getMapCache(String name, Codec codec, MapCacheOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given MaxIdleTime and TTL settings.
  If eviction is not required then it's better to use regular map RedissonClient.getMap(String, Codec).
  
  Specified by:
  
  getMapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - object name
  
  codec - codec for keys and values
  
  options - map options
  
  Returns:
  
  MapCache object
- getMapCache
  
  public <K, V> RMapCache<K,V> getMapCache(MapCacheOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns map-based cache instance with specified options. Supports entry eviction with a given MaxIdleTime and TTL settings.
  If eviction is not required then it's better to use regular map RedissonClient.getMap(org.redisson.api.options.MapOptions).
  
  Specified by:
  
  getMapCache in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  MapCache object
- getMap
  
  public <K, V> RMap<K,V> getMap(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns map instance by name using provided codec for both map keys and values.
  
  Specified by:
  
  getMap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for keys and values
  
  Returns:
  
  Map object
- getMap
  
  public <K, V> RMap<K,V> getMap(String name, Codec codec, MapOptions<K,V> options)
  
  Description copied from interface: RedissonClient
  
  Returns map instance by name using provided codec for both map keys and values.
  
  Specified by:
  
  getMap in interface RedissonClient
  
  Type Parameters:
  
  K - type of key
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for keys and values
  
  options - map options
  
  Returns:
  
  Map object
- getLock
  
  public RLock getLock(String name)
  
  Description copied from interface: RedissonClient
  
  Returns Lock instance by name.
  Implements a non-fair locking so doesn't guarantees an acquire order by threads.
  To increase reliability during failover, all operations wait for propagation to all Redis slaves.
  
  Specified by:
  
  getLock in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Lock object
- getLock
  
  public RLock getLock(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns Lock instance with specified options.
  Implements a non-fair locking so doesn't guarantees an acquire order by threads.
  To increase reliability during failover, all operations wait for propagation to all Redis slaves.
  
  Specified by:
  
  getLock in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Lock object
- getSpinLock
  
  public RLock getSpinLock(String name)
  
  Description copied from interface: RedissonClient
  
  Returns Spin lock instance by name.
  Implements a non-fair locking so doesn't guarantees an acquire order by threads.
  Lock doesn't use a pub/sub mechanism
  
  Specified by:
  
  getSpinLock in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Lock object
- getSpinLock
  
  public RLock getSpinLock(String name, LockOptions.BackOff backOff)
  
  Description copied from interface: RedissonClient
  
  Returns Spin lock instance by name with specified back off options.
  Implements a non-fair locking so doesn't guarantees an acquire order by threads.
  Lock doesn't use a pub/sub mechanism
  
  Specified by:
  
  getSpinLock in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Lock object
- getFencedLock
  
  public RFencedLock getFencedLock(String name)
  
  Description copied from interface: RedissonClient
  
  Returns Fenced Lock instance by name.
  Implements a non-fair locking so doesn't guarantee an acquire order by threads.
  
  Specified by:
  
  getFencedLock in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Lock object
- getFencedLock
  
  public RFencedLock getFencedLock(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns Fenced Lock instance with specified options..
  Implements a non-fair locking so doesn't guarantee an acquire order by threads.
  
  Specified by:
  
  getFencedLock in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Lock object
- getMultiLock
  
  public RLock getMultiLock(RLock... locks)
  
  Description copied from interface: RedissonClient
  
  Returns MultiLock instance associated with specified locks
  
  Specified by:
  
  getMultiLock in interface RedissonClient
  
  Parameters:
  
  locks - collection of locks
  
  Returns:
  
  MultiLock object
- getRedLock
  
  public RLock getRedLock(RLock... locks)
  
  Specified by:
  
  getRedLock in interface RedissonClient
- getFairLock
  
  public RLock getFairLock(String name)
  
  Description copied from interface: RedissonClient
  
  Returns Lock instance by name.
  Implements a fair locking so it guarantees an acquire order by threads.
  To increase reliability during failover, all operations wait for propagation to all Redis slaves.
  
  Specified by:
  
  getFairLock in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Lock object
- getFairLock
  
  public RLock getFairLock(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns Lock instance with specified options.
  Implements a fair locking so it guarantees an acquire order by threads.
  To increase reliability during failover, all operations wait for propagation to all Redis slaves.
  
  Specified by:
  
  getFairLock in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Lock object
- getReadWriteLock
  
  public RReadWriteLock getReadWriteLock(String name)
  
  Description copied from interface: RedissonClient
  
  Returns ReadWriteLock instance by name.
  To increase reliability during failover, all operations wait for propagation to all Redis slaves.
  
  Specified by:
  
  getReadWriteLock in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Lock object
- getReadWriteLock
  
  public RReadWriteLock getReadWriteLock(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns ReadWriteLock instance with specified options.
  To increase reliability during failover, all operations wait for propagation to all Redis slaves.
  
  Specified by:
  
  getReadWriteLock in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Lock object
- getSet
  
  public <V> RSet<V> getSet(String name)
  
  Description copied from interface: RedissonClient
  
  Returns set instance by name.
  
  Specified by:
  
  getSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Set object
- getSet
  
  public <V> RSet<V> getSet(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns set instance by name using provided codec for set objects.
  
  Specified by:
  
  getSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  Set object
- getSet
  
  public <V> RSet<V> getSet(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns set instance with specified options.
  
  Specified by:
  
  getSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Set object
- getFunction
  
  public RFunction getFunction()
  
  Description copied from interface: RedissonClient
  
  Returns API for Redis Function feature
  
  Specified by:
  
  getFunction in interface RedissonClient
  
  Returns:
  
  function object
- getFunction
  
  public RFunction getFunction(Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns API for Redis Function feature using provided codec
  
  Specified by:
  
  getFunction in interface RedissonClient
  
  Parameters:
  
  codec - codec for params and result
  
  Returns:
  
  function interface
- getFunction
  
  public RFunction getFunction(OptionalOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns interface for Redis Function feature with specified options.
  
  Specified by:
  
  getFunction in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  function object
- getScript
  
  public RScript getScript()
  
  Description copied from interface: RedissonClient
  
  Returns script operations object
  
  Specified by:
  
  getScript in interface RedissonClient
  
  Returns:
  
  Script object
- getScript
  
  public RScript getScript(Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns script operations object using provided codec.
  
  Specified by:
  
  getScript in interface RedissonClient
  
  Parameters:
  
  codec - codec for params and result
  
  Returns:
  
  Script object
- getScript
  
  public RScript getScript(OptionalOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns script operations object with specified options.
  
  Specified by:
  
  getScript in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Script object
- getExecutorService
  
  public RScheduledExecutorService getExecutorService(String name)
  
  Description copied from interface: RedissonClient
  
  Returns ScheduledExecutorService by name
  
  Specified by:
  
  getExecutorService in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  ScheduledExecutorService object
- getExecutorService
  
  public RScheduledExecutorService getExecutorService(String name, ExecutorOptions options)
  
  Description copied from interface: RedissonClient
  
  Use RedissonClient.getExecutorService(org.redisson.api.options.ExecutorOptions) instead
  
  Specified by:
  
  getExecutorService in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  options - options for executor
  
  Returns:
  
  ScheduledExecutorService object
- getExecutorService
  
  public RScheduledExecutorService getExecutorService(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns ScheduledExecutorService by name using provided codec for task, response and request serialization
  
  Specified by:
  
  getExecutorService in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  codec - codec for task, response and request
  
  Returns:
  
  ScheduledExecutorService object
- getExecutorService
  
  public RScheduledExecutorService getExecutorService(String name, Codec codec, ExecutorOptions options)
  
  Description copied from interface: RedissonClient
  
  Use RedissonClient.getExecutorService(org.redisson.api.options.ExecutorOptions) instead
  
  Specified by:
  
  getExecutorService in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  codec - codec for task, response and request
  
  options - options for executor
  
  Returns:
  
  ScheduledExecutorService object
- getExecutorService
  
  public RScheduledExecutorService getExecutorService(ExecutorOptions options)
  
  Description copied from interface: RedissonClient
  Returns ScheduledExecutorService with defined options
  Usage examples:
  RScheduledExecutorService service = redisson.getExecutorService( ExecutorOptions.name("test") .taskRetryInterval(Duration.ofSeconds(60)));
  Specified by:
  
  getExecutorService in interface RedissonClient
  
  Parameters:
  
  options - options instance
  
  Returns:
  
  ScheduledExecutorService object
- getRemoteService
  
  public RRemoteService getRemoteService()
  
  Description copied from interface: RedissonClient
  
  Returns object for remote operations prefixed with the default name (redisson_remote_service)
  
  Specified by:
  
  getRemoteService in interface RedissonClient
  
  Returns:
  
  RemoteService object
- getRemoteService
  
  public RRemoteService getRemoteService(String name)
  
  Description copied from interface: RedissonClient
  
  Returns object for remote operations prefixed with the specified name
  
  Specified by:
  
  getRemoteService in interface RedissonClient
  
  Parameters:
  
  name - the name used as the Redis key prefix for the services
  
  Returns:
  
  RemoteService object
- getRemoteService
  
  public RRemoteService getRemoteService(Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.
  
  Specified by:
  
  getRemoteService in interface RedissonClient
  
  Parameters:
  
  codec - codec for response and request
  
  Returns:
  
  RemoteService object
- getRemoteService
  
  public RRemoteService getRemoteService(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.
  
  Specified by:
  
  getRemoteService in interface RedissonClient
  
  Parameters:
  
  name - the name used as the Redis key prefix for the services
  
  codec - codec for response and request
  
  Returns:
  
  RemoteService object
- getRemoteService
  
  public RRemoteService getRemoteService(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns object for remote operations prefixed with specified options.
  
  Specified by:
  
  getRemoteService in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  RemoteService object
- getSortedSet
  
  public <V> RSortedSet<V> getSortedSet(String name)
  
  Description copied from interface: RedissonClient
  
  Returns sorted set instance by name. This sorted set uses comparator to sort objects.
  
  Specified by:
  
  getSortedSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  SortedSet object
- getSortedSet
  
  public <V> RSortedSet<V> getSortedSet(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns sorted set instance by name using provided codec for sorted set objects. This sorted set sorts objects using comparator.
  
  Specified by:
  
  getSortedSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  SortedSet object
- getSortedSet
  
  public <V> RSortedSet<V> getSortedSet(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns sorted set instance with specified options. This sorted set uses comparator to sort objects.
  
  Specified by:
  
  getSortedSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  SortedSet object
- getScoredSortedSet
  
  public <V> RScoredSortedSet<V> getScoredSortedSet(String name)
  
  Description copied from interface: RedissonClient
  
  Returns Redis Sorted Set instance by name. This sorted set sorts objects by object score.
  
  Specified by:
  
  getScoredSortedSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  ScoredSortedSet object
- getScoredSortedSet
  
  public <V> RScoredSortedSet<V> getScoredSortedSet(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns Redis Sorted Set instance by name using provided codec for sorted set objects. This sorted set sorts objects by object score.
  
  Specified by:
  
  getScoredSortedSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  ScoredSortedSet object
- getScoredSortedSet
  
  public <V> RScoredSortedSet<V> getScoredSortedSet(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns Redis Sorted Set instance with specified options. This sorted set sorts objects by object score.
  
  Specified by:
  
  getScoredSortedSet in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  ScoredSortedSet object
- getLexSortedSet
  
  public RLexSortedSet getLexSortedSet(String name)
  
  Description copied from interface: RedissonClient
  
  Returns String based Redis Sorted Set instance by name. All elements are inserted with the same score during addition, in order to force lexicographical ordering
  
  Specified by:
  
  getLexSortedSet in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  LexSortedSet object
- getLexSortedSet
  
  public RLexSortedSet getLexSortedSet(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns String based Redis Sorted Set instance with specified options. All elements are inserted with the same score during addition, in order to force lexicographical ordering
  
  Specified by:
  
  getLexSortedSet in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  LexSortedSet object
- getShardedTopic
  
  public RShardedTopic getShardedTopic(String name)
  
  Description copied from interface: RedissonClient
  
  Returns Sharded Topic instance by name.
  Messages are delivered to message listeners connected to the same Topic.
  
  Specified by:
  
  getShardedTopic in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Topic object
- getShardedTopic
  
  public RShardedTopic getShardedTopic(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns Sharded Topic instance by name using provided codec for messages.
  Messages are delivered to message listeners connected to the same Topic.
  
  Specified by:
  
  getShardedTopic in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  codec - codec for message
  
  Returns:
  
  Topic object
- getShardedTopic
  
  public RShardedTopic getShardedTopic(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns Sharded Topic instance with specified options.
  Messages are delivered to message listeners connected to the same Topic.
  
  Specified by:
  
  getShardedTopic in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Topic object
- getTopic
  
  public RTopic getTopic(String name)
  
  Description copied from interface: RedissonClient
  
  Returns topic instance by name.
  Messages are delivered to message listeners connected to the same Topic.
  
  Specified by:
  
  getTopic in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Topic object
- getTopic
  
  public RTopic getTopic(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns topic instance by name using provided codec for messages.
  Messages are delivered to message listeners connected to the same Topic.
  
  Specified by:
  
  getTopic in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  codec - codec for message
  
  Returns:
  
  Topic object
- getTopic
  
  public RTopic getTopic(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns topic instance with specified options.
  Messages are delivered to message listeners connected to the same Topic.
  
  Specified by:
  
  getTopic in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Topic object
- getReliableTopic
  
  public RReliableTopic getReliableTopic(String name)
  
  Description copied from interface: RedissonClient
  
  Returns reliable topic instance by name.
  Dedicated Redis connection is allocated per instance (subscriber) of this object. Messages are delivered to all listeners attached to the same Redis setup.
  Requires Redis 5.0.0 and higher.
  
  Specified by:
  
  getReliableTopic in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  ReliableTopic object
- getReliableTopic
  
  public RReliableTopic getReliableTopic(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns reliable topic instance by name using provided codec for messages.
  Dedicated Redis connection is allocated per instance (subscriber) of this object. Messages are delivered to all listeners attached to the same Redis setup.
  Requires Redis 5.0.0 and higher.
  
  Specified by:
  
  getReliableTopic in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  codec - codec for message
  
  Returns:
  
  ReliableTopic object
- getReliableTopic
  
  public RReliableTopic getReliableTopic(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns reliable topic instance with specified options.
  Dedicated Redis connection is allocated per instance (subscriber) of this object. Messages are delivered to all listeners attached to the same Redis setup.
  Requires Redis 5.0.0 and higher.
  
  Specified by:
  
  getReliableTopic in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  ReliableTopic object
- getPatternTopic
  
  public RPatternTopic getPatternTopic(String pattern)
  
  Description copied from interface: RedissonClient
  
  Returns topic instance satisfies by pattern name. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo
  
  Specified by:
  
  getPatternTopic in interface RedissonClient
  
  Parameters:
  
  pattern - of the topic
  
  Returns:
  
  PatterTopic object
- getPatternTopic
  
  public RPatternTopic getPatternTopic(String pattern, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns topic instance satisfies by pattern name using provided codec for messages. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo
  
  Specified by:
  
  getPatternTopic in interface RedissonClient
  
  Parameters:
  
  pattern - of the topic
  
  codec - codec for message
  
  Returns:
  
  PatterTopic object
- getPatternTopic
  
  public RPatternTopic getPatternTopic(PatternTopicOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns topic instance satisfies pattern name and specified options.. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo
  
  Specified by:
  
  getPatternTopic in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  PatterTopic object
- getDelayedQueue
  
  public <V> RDelayedQueue<V> getDelayedQueue(RQueue<V> destinationQueue)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded delayed queue instance by name.
  Could be attached to destination queue only. All elements are inserted with transfer delay to destination queue.
  
  Specified by:
  
  getDelayedQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  destinationQueue - destination queue
  
  Returns:
  
  Delayed queue object
- getQueue
  
  public <V> RQueue<V> getQueue(String name)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded queue instance by name.
  
  Specified by:
  
  getQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - of object
  
  Returns:
  
  queue object
- getQueue
  
  public <V> RQueue<V> getQueue(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded queue instance by name using provided codec for queue objects.
  
  Specified by:
  
  getQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for message
  
  Returns:
  
  Queue object
- getQueue
  
  public <V> RQueue<V> getQueue(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded queue instance with specified options.
  
  Specified by:
  
  getQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  queue object
- getTransferQueue
  
  public <V> RTransferQueue<V> getTransferQueue(String name)
  
  Description copied from interface: RedissonClient
  
  Returns transfer queue instance by name.
  
  Specified by:
  
  getTransferQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of values
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  TransferQueue object
- getTransferQueue
  
  public <V> RTransferQueue<V> getTransferQueue(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns transfer queue instance by name using provided codec for queue objects.
  
  Specified by:
  
  getTransferQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of values
  
  Parameters:
  
  name - name of object
  
  codec - code for values
  
  Returns:
  
  TransferQueue object
- getTransferQueue
  
  public <V> RTransferQueue<V> getTransferQueue(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns transfer queue instance with specified options.
  
  Specified by:
  
  getTransferQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of values
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  TransferQueue object
- getRingBuffer
  
  public <V> RRingBuffer<V> getRingBuffer(String name)
  
  Description copied from interface: RedissonClient
  
  Returns RingBuffer based queue.
  
  Specified by:
  
  getRingBuffer in interface RedissonClient
  
  Type Parameters:
  
  V - value type
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  RingBuffer object
- getRingBuffer
  
  public <V> RRingBuffer<V> getRingBuffer(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns RingBuffer based queue.
  
  Specified by:
  
  getRingBuffer in interface RedissonClient
  
  Type Parameters:
  
  V - value type
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  RingBuffer object
- getRingBuffer
  
  public <V> RRingBuffer<V> getRingBuffer(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns RingBuffer based queue instance with specified options.
  
  Specified by:
  
  getRingBuffer in interface RedissonClient
  
  Type Parameters:
  
  V - value type
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  RingBuffer object
- getBlockingQueue
  
  public <V> RBlockingQueue<V> getBlockingQueue(String name)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded blocking queue instance by name.
  
  Specified by:
  
  getBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  BlockingQueue object
- getBlockingQueue
  
  public <V> RBlockingQueue<V> getBlockingQueue(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded blocking queue instance by name using provided codec for queue objects.
  
  Specified by:
  
  getBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of queue
  
  codec - queue objects codec
  
  Returns:
  
  BlockingQueue object
- getBlockingQueue
  
  public <V> RBlockingQueue<V> getBlockingQueue(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded blocking queue instance with specified options.
  
  Specified by:
  
  getBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  BlockingQueue object
- getBoundedBlockingQueue
  
  public <V> RBoundedBlockingQueue<V> getBoundedBlockingQueue(String name)
  
  Description copied from interface: RedissonClient
  
  Returns bounded blocking queue instance by name.
  
  Specified by:
  
  getBoundedBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - of queue
  
  Returns:
  
  BoundedBlockingQueue object
- getBoundedBlockingQueue
  
  public <V> RBoundedBlockingQueue<V> getBoundedBlockingQueue(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns bounded blocking queue instance by name using provided codec for queue objects.
  
  Specified by:
  
  getBoundedBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of queue
  
  codec - codec for values
  
  Returns:
  
  BoundedBlockingQueue object
- getBoundedBlockingQueue
  
  public <V> RBoundedBlockingQueue<V> getBoundedBlockingQueue(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns bounded blocking queue instance with specified options.
  
  Specified by:
  
  getBoundedBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  BoundedBlockingQueue object
- getDeque
  
  public <V> RDeque<V> getDeque(String name)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded deque instance by name.
  
  Specified by:
  
  getDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Deque object
- getDeque
  
  public <V> RDeque<V> getDeque(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded deque instance by name using provided codec for deque objects.
  
  Specified by:
  
  getDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  Deque object
- getDeque
  
  public <V> RDeque<V> getDeque(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded deque instance with specified options.
  
  Specified by:
  
  getDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Deque object
- getBlockingDeque
  
  public <V> RBlockingDeque<V> getBlockingDeque(String name)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded blocking deque instance by name.
  
  Specified by:
  
  getBlockingDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  BlockingDeque object
- getBlockingDeque
  
  public <V> RBlockingDeque<V> getBlockingDeque(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded blocking deque instance by name using provided codec for deque objects.
  
  Specified by:
  
  getBlockingDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - deque objects codec
  
  Returns:
  
  BlockingDeque object
- getBlockingDeque
  
  public <V> RBlockingDeque<V> getBlockingDeque(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded blocking deque instance with specified options.
  
  Specified by:
  
  getBlockingDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  BlockingDeque object
- getAtomicLong
  
  public RAtomicLong getAtomicLong(String name)
  
  Description copied from interface: RedissonClient
  
  Returns atomicLong instance by name.
  
  Specified by:
  
  getAtomicLong in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  AtomicLong object
- getAtomicLong
  
  public RAtomicLong getAtomicLong(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns atomicLong instance with specified options.
  
  Specified by:
  
  getAtomicLong in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  AtomicLong object
- getLongAdder
  
  public RLongAdder getLongAdder(String name)
  
  Description copied from interface: RedissonClient
  
  Returns LongAdder instances by name.
  
  Specified by:
  
  getLongAdder in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  LongAdder object
- getLongAdder
  
  public RLongAdder getLongAdder(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns LongAdder instances with specified options.
  
  Specified by:
  
  getLongAdder in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  LongAdder object
- getDoubleAdder
  
  public RDoubleAdder getDoubleAdder(String name)
  
  Description copied from interface: RedissonClient
  
  Returns DoubleAdder instances by name.
  
  Specified by:
  
  getDoubleAdder in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  LongAdder object
- getDoubleAdder
  
  public RDoubleAdder getDoubleAdder(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns DoubleAdder instances with specified options.
  
  Specified by:
  
  getDoubleAdder in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  LongAdder object
- getAtomicDouble
  
  public RAtomicDouble getAtomicDouble(String name)
  
  Description copied from interface: RedissonClient
  
  Returns atomicDouble instance by name.
  
  Specified by:
  
  getAtomicDouble in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  AtomicDouble object
- getAtomicDouble
  
  public RAtomicDouble getAtomicDouble(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns atomicDouble instance with specified options.
  
  Specified by:
  
  getAtomicDouble in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  AtomicDouble object
- getCountDownLatch
  
  public RCountDownLatch getCountDownLatch(String name)
  
  Description copied from interface: RedissonClient
  
  Returns countDownLatch instance by name.
  
  Specified by:
  
  getCountDownLatch in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  CountDownLatch object
- getCountDownLatch
  
  public RCountDownLatch getCountDownLatch(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns countDownLatch instance with specified options.
  
  Specified by:
  
  getCountDownLatch in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  CountDownLatch object
- getBitSet
  
  public RBitSet getBitSet(String name)
  
  Description copied from interface: RedissonClient
  
  Returns bitSet instance by name.
  
  Specified by:
  
  getBitSet in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  BitSet object
- getBitSet
  
  public RBitSet getBitSet(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns bitSet instance with specified options.
  
  Specified by:
  
  getBitSet in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  BitSet object
- getSemaphore
  
  public RSemaphore getSemaphore(String name)
  
  Description copied from interface: RedissonClient
  
  Returns semaphore instance by name
  
  Specified by:
  
  getSemaphore in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  Semaphore object
- getSemaphore
  
  public RSemaphore getSemaphore(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns semaphore instance with specified options.
  
  Specified by:
  
  getSemaphore in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Semaphore object
- getPermitExpirableSemaphore
  
  public RPermitExpirableSemaphore getPermitExpirableSemaphore(String name)
  
  Description copied from interface: RedissonClient
  
  Returns semaphore instance by name. Supports lease time parameter for each acquired permit.
  
  Specified by:
  
  getPermitExpirableSemaphore in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  PermitExpirableSemaphore object
- getPermitExpirableSemaphore
  
  public RPermitExpirableSemaphore getPermitExpirableSemaphore(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns semaphore instance with specified options. Supports lease time parameter for each acquired permit.
  
  Specified by:
  
  getPermitExpirableSemaphore in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  PermitExpirableSemaphore object
- getBloomFilter
  
  public <V> RBloomFilter<V> getBloomFilter(String name)
  
  Description copied from interface: RedissonClient
  
  Returns bloom filter instance by name.
  
  Specified by:
  
  getBloomFilter in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  BloomFilter object
- getBloomFilter
  
  public <V> RBloomFilter<V> getBloomFilter(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns bloom filter instance by name using provided codec for objects.
  
  Specified by:
  
  getBloomFilter in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for values
  
  Returns:
  
  BloomFilter object
- getBloomFilter
  
  public <V> RBloomFilter<V> getBloomFilter(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns bloom filter instance with specified options.
  
  Specified by:
  
  getBloomFilter in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  BloomFilter object
- getIdGenerator
  
  public RIdGenerator getIdGenerator(String name)
  
  Description copied from interface: RedissonClient
  
  Returns id generator instance by name.
  
  Specified by:
  
  getIdGenerator in interface RedissonClient
  
  Parameters:
  
  name - name of object
  
  Returns:
  
  IdGenerator object
- getIdGenerator
  
  public RIdGenerator getIdGenerator(CommonOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns id generator instance with specified options.
  
  Specified by:
  
  getIdGenerator in interface RedissonClient
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  IdGenerator object
- getKeys
  
  public RKeys getKeys()
  
  Description copied from interface: RedissonClient
  
  Returns interface with methods for Redis keys. Each of Redis/Redisson object associated with own key
  
  Specified by:
  
  getKeys in interface RedissonClient
  
  Returns:
  
  Keys object
- getKeys
  
  public RKeys getKeys(KeysOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns interface for operations over Redis keys with specified options. Each of Redis/Redisson object is associated with own key.
  
  Specified by:
  
  getKeys in interface RedissonClient
  
  Returns:
  
  Keys object
- createTransaction
  
  public RTransaction createTransaction(TransactionOptions options)
  
  Description copied from interface: RedissonClient
  
  Creates transaction with READ_COMMITTED isolation level.
  
  Specified by:
  
  createTransaction in interface RedissonClient
  
  Parameters:
  
  options - transaction configuration
  
  Returns:
  
  Transaction object
- createBatch
  
  public RBatch createBatch(BatchOptions options)
  
  Description copied from interface: RedissonClient
  
  Creates batch object which could be executed later with collected group of commands in pipeline mode.
  See http://redis.io/topics/pipelining
  
  Specified by:
  
  createBatch in interface RedissonClient
  
  Parameters:
  
  options - batch configuration
  
  Returns:
  
  Batch object
- createBatch
  
  public RBatch createBatch()
  
  Description copied from interface: RedissonClient
  
  Creates batch object which could be executed later with collected group of commands in pipeline mode.
  See http://redis.io/topics/pipelining
  
  Specified by:
  
  createBatch in interface RedissonClient
  
  Returns:
  
  Batch object
- getLiveObjectService
  
  public RLiveObjectService getLiveObjectService()
  
  Description copied from interface: RedissonClient
  
  Returns Live Object Service which is used to store Java objects
  
  Specified by:
  
  getLiveObjectService in interface RedissonClient
  
  Returns:
  
  LiveObjectService object
- getLiveObjectService
  
  public RLiveObjectService getLiveObjectService(LiveObjectOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns Live Object Service which is used to store Java objects with specified options.
  
  Specified by:
  
  getLiveObjectService in interface RedissonClient
  
  Returns:
  
  LiveObjectService object
- shutdown
  
  public void shutdown()
  
  Description copied from interface: RedissonClient
  
  Shutdown Redisson instance but NOT Redis server This equates to invoke shutdown(0, 2, TimeUnit.SECONDS);
  
  Specified by:
  
  shutdown in interface RedissonClient
- shutdown
  
  public void shutdown(long quietPeriod, long timeout, TimeUnit unit)
  
  Description copied from interface: RedissonClient
  
  Shuts down Redisson instance but NOT Redis server Shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a task is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over.
  
  Specified by:
  
  shutdown in interface RedissonClient
  
  Parameters:
  
  quietPeriod - the quiet period as described in the documentation
  
  timeout - the maximum amount of time to wait until the executor is RedissonClient.shutdown() regardless if a task was submitted during the quiet period
  
  unit - the unit of quietPeriod and timeout
- getConfig
  
  public Config getConfig()
  
  Description copied from interface: RedissonClient
  
  Allows to get configuration provided during Redisson instance creation. Further changes on this object not affect Redisson instance.
  
  Specified by:
  
  getConfig in interface RedissonClient
  
  Returns:
  
  Config object
- getRedisNodes
  
  public <T extends BaseRedisNodes> T getRedisNodes(RedisNodes<T> nodes)
  
  Description copied from interface: RedissonClient
  
  Returns API to manage Redis nodes
  Specified by:
  
  getRedisNodes in interface RedissonClient
  
  Type Parameters:
  
  T - type of Redis nodes API
  
  Parameters:
  
  nodes - Redis nodes API class
  
  Returns:
  
  Redis nodes API object
  
  See Also:
  
  RedisNodes.CLUSTER
  
  RedisNodes.MASTER_SLAVE
  
  RedisNodes.SENTINEL_MASTER_SLAVE
  
  RedisNodes.SINGLE
- getNodesGroup
  
  public NodesGroup<Node> getNodesGroup()
  
  Specified by:
  
  getNodesGroup in interface RedissonClient
- getClusterNodesGroup
  
  public ClusterNodesGroup getClusterNodesGroup()
  
  Specified by:
  
  getClusterNodesGroup in interface RedissonClient
- isShutdown
  
  public boolean isShutdown()
  
  Description copied from interface: RedissonClient
  
  Returns true if this Redisson instance has been shut down.
  
  Specified by:
  
  isShutdown in interface RedissonClient
  
  Returns:
  
  true if this Redisson instance has been shut down overwise false
- isShuttingDown
  
  public boolean isShuttingDown()
  
  Description copied from interface: RedissonClient
  
  Returns true if this Redisson instance was started to be shutdown or was shutdown RedissonClient.isShutdown() already.
  
  Specified by:
  
  isShuttingDown in interface RedissonClient
  
  Returns:
  
  true if this Redisson instance was started to be shutdown or was shutdown RedissonClient.isShutdown() already.
- getPriorityQueue
  
  public <V> RPriorityQueue<V> getPriorityQueue(String name)
  
  Description copied from interface: RedissonClient
  
  Returns priority unbounded queue instance by name. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - of object
  
  Returns:
  
  Queue object
- getPriorityQueue
  
  public <V> RPriorityQueue<V> getPriorityQueue(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns priority unbounded queue instance by name using provided codec for queue objects. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for message
  
  Returns:
  
  Queue object
- getPriorityQueue
  
  public <V> RPriorityQueue<V> getPriorityQueue(PlainOptions options)
  
  Specified by:
  
  getPriorityQueue in interface RedissonClient
- getPriorityBlockingQueue
  
  public <V> RPriorityBlockingQueue<V> getPriorityBlockingQueue(String name)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded priority blocking queue instance by name. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - of object
  
  Returns:
  
  Queue object
- getPriorityBlockingQueue
  
  public <V> RPriorityBlockingQueue<V> getPriorityBlockingQueue(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded priority blocking queue instance by name using provided codec for queue objects. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for message
  
  Returns:
  
  Queue object
- getPriorityBlockingQueue
  
  public <V> RPriorityBlockingQueue<V> getPriorityBlockingQueue(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded priority blocking queue instance with specified options. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityBlockingQueue in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Queue object
- getPriorityBlockingDeque
  
  public <V> RPriorityBlockingDeque<V> getPriorityBlockingDeque(String name)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded priority blocking deque instance by name. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityBlockingDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - of object
  
  Returns:
  
  Queue object
- getPriorityBlockingDeque
  
  public <V> RPriorityBlockingDeque<V> getPriorityBlockingDeque(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded priority blocking deque instance by name using provided codec for queue objects. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityBlockingDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for message
  
  Returns:
  
  Queue object
- getPriorityBlockingDeque
  
  public <V> RPriorityBlockingDeque<V> getPriorityBlockingDeque(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns unbounded priority blocking deque instance with specified options. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityBlockingDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Queue object
- getPriorityDeque
  
  public <V> RPriorityDeque<V> getPriorityDeque(String name)
  
  Description copied from interface: RedissonClient
  
  Returns priority unbounded deque instance by name. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - of object
  
  Returns:
  
  Queue object
- getPriorityDeque
  
  public <V> RPriorityDeque<V> getPriorityDeque(String name, Codec codec)
  
  Description copied from interface: RedissonClient
  
  Returns priority unbounded deque instance by name using provided codec for queue objects. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  name - name of object
  
  codec - codec for message
  
  Returns:
  
  Queue object
- getPriorityDeque
  
  public <V> RPriorityDeque<V> getPriorityDeque(PlainOptions options)
  
  Description copied from interface: RedissonClient
  
  Returns priority unbounded deque instance with specified options. It uses comparator to sort objects.
  
  Specified by:
  
  getPriorityDeque in interface RedissonClient
  
  Type Parameters:
  
  V - type of value
  
  Parameters:
  
  options - instance options
  
  Returns:
  
  Queue object
- getId
  
  public String getId()
  
  Description copied from interface: RedissonClient
  
  Returns id of this Redisson instance
  
  Specified by:
  
  getId in interface RedissonClient
  
  Returns:
  
  id

Class Redisson

Method Summary

Methods inherited from class java.lang.Object

Method Details

getEvictionScheduler

getCommandExecutor

getConnectionManager

getServiceManager

create

create

createRx

createRx

rxJava

createReactive

createReactive

reactive

getTimeSeries

getTimeSeries

getTimeSeries

getStream

getStream

getStream

getSearch

getSearch

getSearch

getBinaryStream

getBinaryStream

getGeo

getGeo

getGeo

getBucket

getRateLimiter

getRateLimiter

getBucket

getBucket

getBuckets

getBuckets

getBuckets

getJsonBucket

getJsonBucket

getHyperLogLog

getHyperLogLog

getHyperLogLog

getList

getList

getList

getListMultimap

getListMultimap

getListMultimap

getLocalCachedMap

getLocalCachedMap

getLocalCachedMap

getMap

getMap

getMap

getSetMultimap

getSetMultimapCache

getSetMultimapCache

getSetMultimapCache

getListMultimapCache

getListMultimapCache

getListMultimapCache

getSetMultimap

getSetMultimap

getSetCache

getSetCache

getSetCache

getMapCache

getMapCache

getMapCache

getMapCache

getMapCache

getMap

getMap

getLock

getLock

getSpinLock

getSpinLock

getFencedLock

getFencedLock