io.lettuce.core

Class XReadArgs.Builder

java.lang.Object

io.lettuce.core.XReadArgs.Builder

Enclosing class:

XReadArgs

public static class XReadArgs.Builder
extends Object

Builder entry points for XReadArgs.

Method Summary

Modifier and Type	Method and Description
static XReadArgs	block(Duration timeout) Create a new XReadArgs and set BLOCK.
static XReadArgs	block(long milliseconds) Create a new XReadArgs and set BLOCK.
static XReadArgs	claim(Duration timeout) Create a new XReadArgs and set CLAIM min-idle-time.
static XReadArgs	claim(long milliseconds) Create a new XReadArgs and set CLAIM min-idle-time.
static XReadArgs	count(long count) Create a new XReadArgs and set COUNT.
static XReadArgs	maxCount(long maxCount) Create a new XReadArgs and set MAXCOUNT.
static XReadArgs	maxSize(long maxSize) Create a new XReadArgs and set MAXSIZE.
static XReadArgs	noack() Create a new XReadArgs and set NOACK.
static XReadArgs	noack(boolean noack) Create a new XReadArgs and set NOACK.

Methods inherited from class java.lang.Object

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

Method Detail

block

public static XReadArgs block(long milliseconds)

Create a new XReadArgs and set BLOCK.

Parameters:

milliseconds - time to block.

Returns:

new XReadArgs with BLOCK set.

See Also:

XReadArgs.block(long)

block

public static XReadArgs block(Duration timeout)

Create a new XReadArgs and set BLOCK.

Parameters:

timeout - time to block.

Returns:

new XReadArgs with BLOCK set.

See Also:

XReadArgs.block(Duration)

count

public static XReadArgs count(long count)

Create a new XReadArgs and set COUNT.

Parameters:

count -

Returns:

new XReadArgs with COUNT set.

maxCount

public static XReadArgs maxCount(long maxCount)

Create a new XReadArgs and set MAXCOUNT.

Parameters:

maxCount - cumulative cap on the number of returned entries across all streams, must be positive.

Returns:

new XReadArgs with MAXCOUNT set.

Since:

7.7

See Also:

XReadArgs.maxCount(long)

maxSize

public static XReadArgs maxSize(long maxSize)

Create a new XReadArgs and set MAXSIZE.

Parameters:

maxSize - soft cumulative cap on the reply size in bytes across all streams, must be positive.

Returns:

new XReadArgs with MAXSIZE set.

Since:

7.7

See Also:

XReadArgs.maxSize(long)

noack

public static XReadArgs noack()

Create a new XReadArgs and set NOACK.

Returns:

new XReadArgs with NOACK set.

See Also:

XReadArgs.noack(boolean)

noack

public static XReadArgs noack(boolean noack)

Create a new XReadArgs and set NOACK.

Parameters:

noack -

Returns:

new XReadArgs with NOACK set.

See Also:

XReadArgs.noack(boolean)

claim

public static XReadArgs claim(long milliseconds)

Create a new XReadArgs and set CLAIM min-idle-time.

Parameters:

milliseconds - minimum idle time.

Returns:

new XReadArgs with CLAIM set

Since:

7.1

claim

public static XReadArgs claim(Duration timeout)

Create a new XReadArgs and set CLAIM min-idle-time.

Parameters:

timeout - minimum idle time.

Returns:

new XReadArgs with CLAIM set

Since:

7.1