Package org.redisson.api.stream

Class StreamTrimParams

java.lang.Object

org.redisson.api.stream.BaseReferencesParams<StreamTrimLimitArgs<StreamTrimArgs>>

org.redisson.api.stream.StreamTrimParams

All Implemented Interfaces:

StreamReferencesArgs<StreamTrimLimitArgs<StreamTrimArgs>>, StreamTrimArgs, StreamTrimLimitArgs<StreamTrimArgs>, StreamTrimReferencesArgs<StreamTrimArgs>, StreamTrimStrategyArgs<StreamTrimArgs>

public final class StreamTrimParams
extends BaseReferencesParams<StreamTrimLimitArgs<StreamTrimArgs>>
implements StreamTrimStrategyArgs<StreamTrimArgs>, StreamTrimArgs, StreamTrimReferencesArgs<StreamTrimArgs>

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
int	getLimit()
Integer	getMaxLen()
StreamMessageId	getMinId()
StreamTrimArgs	limit(int size)	Defines limit of evicted objects for trim command.
StreamTrimReferencesArgs<StreamTrimArgs>	maxLen(int threshold)	Defines MAXLEN strategy used for Stream trimming.
StreamTrimReferencesArgs<StreamTrimArgs>	minId(StreamMessageId messageId)	Defines MINID strategy used for Stream trimming.
StreamTrimArgs	noLimit()	Defines no limit of evicted objects for trim command.

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

maxLen

public StreamTrimReferencesArgs<StreamTrimArgs> 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<StreamTrimArgs>

Parameters:

threshold - - trim threshold

Returns:

arguments object

minId

public StreamTrimReferencesArgs<StreamTrimArgs> 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<StreamTrimArgs>

Parameters:

messageId - - stream Id

Returns:

arguments object

noLimit

public StreamTrimArgs noLimit()

Description copied from interface: StreamTrimLimitArgs

Defines no limit of evicted objects for trim command.

Specified by:

noLimit in interface StreamTrimLimitArgs<StreamTrimArgs>

Returns:

arguments object

limit

public StreamTrimArgs limit(int size)

Description copied from interface: StreamTrimLimitArgs

Defines limit of evicted objects for trim command.

Specified by:

limit in interface StreamTrimLimitArgs<StreamTrimArgs>

Parameters:

size - max amount of evicted objects

Returns:

arguments object

getMaxLen

public Integer getMaxLen()

getMinId

public StreamMessageId getMinId()

getLimit

public int getLimit()