Package org.redisson.api.options

Interface KeysScanOptions

All Known Implementing Classes:
KeysScanParams
public interface KeysScanOptions
RKeys.getKeys() method options
Author:
Nikita Koksharov

  • Method Details

    • defaults

      static KeysScanOptions defaults()
      Creates the default options
      Returns:
      options instance

    • limit

      KeysScanOptions limit(int value)
      Defines the total amount of returned keys.
      Parameters:
      value - total amount of returned keys
      Returns:
      options instance

    • pattern

      KeysScanOptions pattern(String value)
      Defines the pattern that all keys should match. Supported glob-style patterns:

      h?llo matches hello, hallo and hxllo

      h*llo matches to hllo and heeeello

      h[ae]llo matches to hello and hallo, but not hillo *

      Parameters:
      value - key pattern
      Returns:
      options instance

    • chunkSize

      KeysScanOptions chunkSize(int value)
      Defines the amount of loaded keys per request.
      Parameters:
      value - amount of loaded keys per request
      Returns:
      options instance

    • type

      KeysScanOptions type(RType value)
      Defines the type of objects that all keys should match.
      Parameters:
      value - type of objects
      Returns:
      options instance