Package org.redisson.api.stream

Interface StreamCreateGroupArgs

All Known Implementing Classes:
StreamCreateGroupParams
public interface StreamCreateGroupArgs
Arguments object for RStream.createGroup(StreamCreateGroupArgs) method.
Author:
Nikita Koksharov

  • Method Details

    • entriesRead

      StreamCreateGroupArgs entriesRead(int amount)
      Defines entries_read argument
      Parameters:
      amount - entries_read argument
      Returns:
      arguments object

    • makeStream

      StreamCreateGroupArgs makeStream()
      Defines whether a stream should be created if it doesn't exist.
      Returns:
      arguments object

    • id

      StreamCreateGroupArgs id(StreamMessageId id)
      Defines Stream Message ID. Only new messages after defined stream id will be available for consumers of this group.

      StreamMessageId.NEWEST is used for messages arrived since the moment of group creation

      StreamMessageId.ALL is used for all messages added before and after the moment of group creation

      Parameters:
      id - Stream Message ID
      Returns:
      arguments object

    • name

      static StreamCreateGroupArgs name(String value)
      Defines name of group. Only new messages will be available for consumers of this group.
      Parameters:
      value - name of group
      Returns:
      arguments object