javadocs fixed

pull/5099/head
Nikita Koksharov 2 years ago
parent dfc49d89cf
commit e911a8785d

@ -46,23 +46,15 @@ public interface RStream<K, V> extends RStreamAsync<K, V>, RExpirable {
void createGroup(StreamCreateGroupArgs args); void createGroup(StreamCreateGroupArgs args);
/** /**
* Creates consumer group by name. * Use createGroup(StreamCreateGroupArgs) method instead
* Only new messages will be available for consumers of this group.
*
* @param groupName - name of group
*/ */
@Deprecated
void createGroup(String groupName); void createGroup(String groupName);
/** /**
* Creates consumer group by name and Stream Message ID. * Use createGroup(StreamCreateGroupArgs) method instead
* Only new messages after defined stream <code>id</code> will be available for consumers of this group.
* <p>
* {@link StreamMessageId#NEWEST} is used for messages arrived since the moment of group creation
* {@link StreamMessageId#ALL} is used for all messages added before and after the moment of group creation
*
* @param groupName - name of group
* @param id - Stream Message ID
*/ */
@Deprecated
void createGroup(String groupName, StreamMessageId id); void createGroup(String groupName, StreamMessageId id);
/** /**

@ -46,23 +46,15 @@ public interface RStreamAsync<K, V> extends RExpirableAsync {
RFuture<Void> createGroupAsync(StreamCreateGroupArgs args); RFuture<Void> createGroupAsync(StreamCreateGroupArgs args);
/** /**
* Creates consumer group by name. * Use createGroupAsync(StreamCreateGroupArgs) method instead
*
* @param groupName - name of group
* @return void
*/ */
@Deprecated
RFuture<Void> createGroupAsync(String groupName); RFuture<Void> createGroupAsync(String groupName);
/** /**
* Creates consumer group by name and stream id. * Use createGroupAsync(StreamCreateGroupArgs) method instead
* Only new messages after defined stream <code>id</code> will be available for consumers of this group.
* <p>
* {@link StreamMessageId#NEWEST} is used for messages arrived since the moment of group creating
*
* @param groupName - name of group
* @param id - stream id
* @return void
*/ */
@Deprecated
RFuture<Void> createGroupAsync(String groupName, StreamMessageId id); RFuture<Void> createGroupAsync(String groupName, StreamMessageId id);
/** /**

@ -47,23 +47,15 @@ public interface RStreamReactive<K, V> extends RExpirableReactive {
Mono<Void> createGroup(StreamCreateGroupArgs args); Mono<Void> createGroup(StreamCreateGroupArgs args);
/** /**
* Creates consumer group by name. * Use createGroup(StreamCreateGroupArgs) method instead
*
* @param groupName - name of group
* @return void
*/ */
@Deprecated
Mono<Void> createGroup(String groupName); Mono<Void> createGroup(String groupName);
/** /**
* Creates consumer group by name and stream id. * Use createGroup(StreamCreateGroupArgs) method instead
* Only new messages after defined stream <code>id</code> will be available for consumers of this group.
* <p>
* {@link StreamMessageId#NEWEST} is used for messages arrived since the moment of group creating
*
* @param groupName - name of group
* @param id - stream id
* @return void
*/ */
@Deprecated
Mono<Void> createGroup(String groupName, StreamMessageId id); Mono<Void> createGroup(String groupName, StreamMessageId id);
/** /**

@ -48,23 +48,15 @@ public interface RStreamRx<K, V> extends RExpirableRx {
Completable createGroup(StreamCreateGroupArgs args); Completable createGroup(StreamCreateGroupArgs args);
/** /**
* Creates consumer group by name. * Use createGroup(StreamCreateGroupArgs) method instead
*
* @param groupName - name of group
* @return void
*/ */
@Deprecated
Completable createGroup(String groupName); Completable createGroup(String groupName);
/** /**
* Creates consumer group by name and stream id. * Use createGroup(StreamCreateGroupArgs) method instead
* Only new messages after defined stream <code>id</code> will be available for consumers of this group.
* <p>
* {@link StreamMessageId#NEWEST} is used for messages arrived since the moment of group creating
*
* @param groupName - name of group
* @param id - stream id
* @return void
*/ */
@Deprecated
Completable createGroup(String groupName, StreamMessageId id); Completable createGroup(String groupName, StreamMessageId id);
/** /**

@ -44,6 +44,10 @@ public interface StreamCreateGroupArgs {
* Defines Stream Message ID. * Defines Stream Message ID.
* Only new messages after defined stream <code>id</code> will * Only new messages after defined stream <code>id</code> will
* be available for consumers of this group. * be available for consumers of this group.
* <p>
* {@link StreamMessageId#NEWEST} is used for messages arrived since the moment of group creation
* <p>
* {@link StreamMessageId#ALL} is used for all messages added before and after the moment of group creation
* *
* @param id Stream Message ID * @param id Stream Message ID
* @return arguments object * @return arguments object

Loading…
Cancel
Save