Package org.redisson.api.stream

Class StreamAddParams<K,V>

java.lang.Object

org.redisson.api.stream.BaseReferencesParams<StreamTrimLimitArgs<StreamAddArgs<K,V>>>

org.redisson.api.stream.StreamAddParams<K,V>

All Implemented Interfaces:

StreamAddArgs<K,V>, StreamReferencesArgs<StreamTrimLimitArgs<StreamAddArgs<K,V>>>, StreamTrimLimitArgs<StreamAddArgs<K,V>>, StreamTrimReferencesArgs<StreamAddArgs<K,V>>, StreamTrimStrategyArgs<StreamAddArgs<K,V>>

public final class StreamAddParams<K,V>
extends BaseReferencesParams<StreamTrimLimitArgs<StreamAddArgs<K,V>>>
implements StreamAddArgs<K,V>, StreamTrimStrategyArgs<StreamAddArgs<K,V>>, StreamTrimReferencesArgs<StreamAddArgs<K,V>>

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
Map<K,V>	getEntries()
int	getLimit()
int	getMaxLen()
StreamMessageId	getMinId()
boolean	isNoMakeStream()
boolean	isTrimStrict()
StreamAddArgs<K,V>	limit(int size)	Defines limit of evicted objects for trim command.
StreamTrimReferencesArgs<StreamAddArgs<K,V>>	maxLen(int threshold)	Defines MAXLEN strategy used for Stream trimming.
StreamTrimReferencesArgs<StreamAddArgs<K,V>>	minId(StreamMessageId messageId)	Defines MINID strategy used for Stream trimming.
StreamAddArgs<K,V>	noLimit()	Defines no limit of evicted objects for trim command.
StreamAddArgs<K,V>	noMakeStream()	Define to not create stream automatically if it doesn't exist.
StreamTrimStrategyArgs<StreamAddArgs<K,V>>	trim()	Defines strict trimming.
StreamTrimStrategyArgs<StreamAddArgs<K,V>>	trimNonStrict()	Defines non-strict trimming.

Methods inherited from class org.redisson.api.stream.BaseReferencesParams

getRefPolicy, keepReferences, removeAcknowledgedOnly, removeReferences

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.redisson.api.stream.StreamReferencesArgs

keepReferences, removeAcknowledgedOnly, removeReferences

Method Details

noMakeStream

public StreamAddArgs<K,V> noMakeStream()

Description copied from interface: StreamAddArgs

Define to not create stream automatically if it doesn't exist.

Specified by:

noMakeStream in interface StreamAddArgs<K,V>

Returns:

arguments object

trim

public StreamTrimStrategyArgs<StreamAddArgs<K,V>> trim()

Description copied from interface: StreamAddArgs

Defines strict trimming.

Specified by:

trim in interface StreamAddArgs<K,V>

Returns:

arguments object

trimNonStrict

public StreamTrimStrategyArgs<StreamAddArgs<K,V>> trimNonStrict()

Description copied from interface: StreamAddArgs

Defines non-strict trimming.

Specified by:

trimNonStrict in interface StreamAddArgs<K,V>

Returns:

arguments object

maxLen

public StreamTrimReferencesArgs<StreamAddArgs<K,V>> maxLen(int threshold)

Description copied from interface: StreamTrimStrategyArgs

Defines MAXLEN strategy used for Stream trimming. Evicts entries which position exceeds the specified stream's length threshold.

Specified by:

maxLen in interface StreamTrimStrategyArgs<K>

Parameters:

threshold - - trim threshold

Returns:

arguments object

minId

public StreamTrimReferencesArgs<StreamAddArgs<K,V>> minId(StreamMessageId messageId)

Description copied from interface: StreamTrimStrategyArgs

Defines MINID strategy used for Stream trimming. Evicts entries with IDs lower than threshold, where threshold is a stream ID.

Specified by:

minId in interface StreamTrimStrategyArgs<K>

Parameters:

messageId - - stream Id

Returns:

arguments object

noLimit

public StreamAddArgs<K,V> noLimit()

Description copied from interface: StreamTrimLimitArgs

Defines no limit of evicted objects for trim command.

Specified by:

noLimit in interface StreamTrimLimitArgs<K>

Returns:

arguments object

limit

public StreamAddArgs<K,V> limit(int size)

Description copied from interface: StreamTrimLimitArgs

Defines limit of evicted objects for trim command.

Specified by:

limit in interface StreamTrimLimitArgs<K>

Parameters:

size - max amount of evicted objects

Returns:

arguments object

getEntries

public Map<K,V> getEntries()

isNoMakeStream

public boolean isNoMakeStream()

isTrimStrict

public boolean isTrimStrict()

getMaxLen

public int getMaxLen()

getMinId

public StreamMessageId getMinId()

getLimit

public int getLimit()