Package org.redisson.api.options

Class KeysScanParams

java.lang.Object
org.redisson.api.options.KeysScanParams
All Implemented Interfaces:
KeysScanOptions
public class KeysScanParams extends Object implements KeysScanOptions
Author:
Nikita Koksharov

  • Constructor Details

    • KeysScanParams

      public KeysScanParams()

  • Method Details

    • limit

      public KeysScanOptions limit(int value)
      Description copied from interface: KeysScanOptions
      Defines the total amount of returned keys.
      Specified by:
      limit in interface KeysScanOptions
      Parameters:
      value - total amount of returned keys
      Returns:
      options instance

    • pattern

      public KeysScanOptions pattern(String value)
      Description copied from interface: KeysScanOptions
      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 *

      Specified by:
      pattern in interface KeysScanOptions
      Parameters:
      value - key pattern
      Returns:
      options instance

    • chunkSize

      public KeysScanOptions chunkSize(int value)
      Description copied from interface: KeysScanOptions
      Defines the amount of loaded keys per request.
      Specified by:
      chunkSize in interface KeysScanOptions
      Parameters:
      value - amount of loaded keys per request
      Returns:
      options instance

    • type

      public KeysScanOptions type(RType value)
      Description copied from interface: KeysScanOptions
      Defines the type of objects that all keys should match.
      Specified by:
      type in interface KeysScanOptions
      Parameters:
      value - type of objects
      Returns:
      options instance

    • getLimit

      public int getLimit()

    • getPattern

      public String getPattern()

    • getChunkSize

      public int getChunkSize()

    • getType

      public RType getType()