Package com.eventstore.dbclient

Class SubscribePersistentSubscriptionOptions

java.lang.Object

com.eventstore.dbclient.SubscribePersistentSubscriptionOptions

public class SubscribePersistentSubscriptionOptions
extends Object

Options of the subscribe persistent subscription request.

Method Summary

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

get

public static SubscribePersistentSubscriptionOptions get()

Returns options with default values.

bufferSize

public SubscribePersistentSubscriptionOptions bufferSize(int value)

Persistent subscription's buffer size.

authenticated

public SubscribePersistentSubscriptionOptions authenticated(UserCredentials credentials)

Sets user credentials for the request

Parameters:

credentials -

Returns:

updated options

See Also:

• UserCredentials

authenticated

public SubscribePersistentSubscriptionOptions authenticated(String login,
 String password)

Sets user credentials for the request

Parameters:

login -

password -

Returns:

updated options

requiresLeader

public SubscribePersistentSubscriptionOptions requiresLeader()

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

Returns:

updated options

notRequireLeader

public SubscribePersistentSubscriptionOptions notRequireLeader()

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

Returns:

updated options

requiresLeader

public SubscribePersistentSubscriptionOptions requiresLeader(boolean value)

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

Parameters:

value -

Returns:

updated options

deadline

public SubscribePersistentSubscriptionOptions deadline(long durationInMs)

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

Parameters:

durationInMs -

Returns:

header

public SubscribePersistentSubscriptionOptions header(String key,
 String value)

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