io.kurrent.dbclient

Class SubscribePersistentSubscriptionOptions

java.lang.Object

io.kurrent.dbclient.SubscribePersistentSubscriptionOptions

public class SubscribePersistentSubscriptionOptions
extends java.lang.Object

Options of the subscribe persistent subscription request.

Method Summary

Modifier and Type	Method and Description
T	authenticated(java.lang.String login, java.lang.String password) Sets user credentials for the request
T	authenticated(UserCredentials credentials) Sets user credentials for the request
SubscribePersistentSubscriptionOptions	bufferSize(int value) Persistent subscription's buffer size.
T	deadline(long durationInMs) A length of time (in milliseconds) to use for gRPC deadlines.
static SubscribePersistentSubscriptionOptions	get() Returns options with default values.
T	header(java.lang.String key, java.lang.String value) Adds a custom HTTP header that will be added to the request.
T	notRequireLeader() Do not require the request to be performed by the leader of the cluster.
T	requiresLeader() Requires the request to be performed by the leader of the cluster.
T	requiresLeader(boolean value) If true, requires the request to be performed by the leader of the cluster.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static SubscribePersistentSubscriptionOptions get()

Returns options with default values.

bufferSize

public SubscribePersistentSubscriptionOptions bufferSize(int value)

Persistent subscription's buffer size.

authenticated

public T authenticated(UserCredentials credentials)

Sets user credentials for the request

Parameters:

credentials -

Returns:

updated options

See Also:

UserCredentials

authenticated

public T authenticated(java.lang.String login,
                       java.lang.String password)

Sets user credentials for the request

Parameters:

login -

password -

Returns:

updated options

requiresLeader

public T requiresLeader()

Requires the request to be performed by the leader of the cluster.

Returns:

updated options

notRequireLeader

public T notRequireLeader()

Do not require the request to be performed by the leader of the cluster.

Returns:

updated options

requiresLeader

public T requiresLeader(boolean value)

If true, requires the request to be performed by the leader of the cluster.

Parameters:

value -

Returns:

updated options

deadline

public T deadline(long durationInMs)

A length of time (in milliseconds) to use for gRPC deadlines.

Parameters:

durationInMs -

Returns:

header

public T header(java.lang.String key,
                java.lang.String value)

Adds a custom HTTP header that will be added to the request.