Package com.eventstore.dbclient

Class UpdatePersistentSubscriptionToStreamOptions

java.lang.Object

com.eventstore.dbclient.UpdatePersistentSubscriptionToStreamOptions

public class UpdatePersistentSubscriptionToStreamOptions
extends Object

Options of the update persistent subscription to stream request.

Method Summary

Modifier and Type	Method	Description
UpdatePersistentSubscriptionToStreamOptions	authenticated(UserCredentials credentials)	Sets user credentials for the request
UpdatePersistentSubscriptionToStreamOptions	authenticated(String login, String password)	Sets user credentials for the request
UpdatePersistentSubscriptionToStreamOptions	checkpointAfter(Duration value)	The amount of time to try to checkpoint after.
UpdatePersistentSubscriptionToStreamOptions	checkpointAfterInMs(int value)	The amount of time in milliseconds to try to checkpoint after.
UpdatePersistentSubscriptionToStreamOptions	checkpointLowerBound(int value)	The minimum number of messages to process before a checkpoint may be written.
UpdatePersistentSubscriptionToStreamOptions	checkpointUpperBound(int value)	The maximum number of messages not checkpointed before forcing a checkpoint.
UpdatePersistentSubscriptionToStreamOptions	deadline(long durationInMs)	A length of time (in milliseconds) to use for gRPC deadlines.
UpdatePersistentSubscriptionToStreamOptions	disableExtraStatistics()	Disable tracking of latency statistics on this subscription.
UpdatePersistentSubscriptionToStreamOptions	disableLinkResolution()	Deprecated. prefer AbstractPersistentSubscriptionSettingsBuilder.notResolveLinkTos()
UpdatePersistentSubscriptionToStreamOptions	enableExtraStatistics()	Enable tracking of latency statistics on this subscription.
UpdatePersistentSubscriptionToStreamOptions	enableLinkResolution()	Deprecated. prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos()
UpdatePersistentSubscriptionToStreamOptions	extraStatistics(boolean value)	Whether to track latency statistics on this subscription.
static UpdatePersistentSubscriptionToStreamOptions	from(PersistentSubscriptionToStreamSettings settings)	Returns options from a persistent subscription to stream settings.
UpdatePersistentSubscriptionToStreamOptions	fromEnd()	Starts the persistent subscription from the end of the stream.
UpdatePersistentSubscriptionToStreamOptions	fromStart()	Starts the persistent subscription from the beginning of the stream.
static UpdatePersistentSubscriptionToStreamOptions	get()	Returns options with default values.
UpdatePersistentSubscriptionToStreamOptions	header(String key, String value)	Adds a custom HTTP header that will be added to the request.
UpdatePersistentSubscriptionToStreamOptions	historyBufferSize(int value)	The number of events to cache when catching up.
UpdatePersistentSubscriptionToStreamOptions	liveBufferSize(int value)	The size of the buffer (in-memory) listening to live messages as they happen before paging occurs.
UpdatePersistentSubscriptionToStreamOptions	maxCheckpointCount(int value)	Deprecated. prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointUpperBound(int value)
UpdatePersistentSubscriptionToStreamOptions	maxRetryCount(int value)	The maximum number of retries (due to timeout) before a message is considered to be parked.
UpdatePersistentSubscriptionToStreamOptions	maxSubscriberCount(int value)	The maximum number of subscribers allowed.
UpdatePersistentSubscriptionToStreamOptions	messageTimeout(Duration value)	The amount of time after which to consider a message as timed out and retried.
UpdatePersistentSubscriptionToStreamOptions	messageTimeoutInMs(int value)	The amount of time in milliseconds after which to consider a message as timed out and retried.
UpdatePersistentSubscriptionToStreamOptions	minCheckpointCount(int value)	Deprecated. prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointLowerBound(int value)
UpdatePersistentSubscriptionToStreamOptions	namedConsumerStrategy(NamedConsumerStrategy value)	The strategy to use for distributing events to client consumers.
UpdatePersistentSubscriptionToStreamOptions	notRequireLeader()	Do not require the request to be performed by the leader of the cluster.
UpdatePersistentSubscriptionToStreamOptions	notResolveLinkTos()	Don't resolve linkTo events to their linked events.
UpdatePersistentSubscriptionToStreamOptions	readBatchSize(int value)	The number of events read at a time when catching up.
UpdatePersistentSubscriptionToStreamOptions	requiresLeader()	Requires the request to be performed by the leader of the cluster.
UpdatePersistentSubscriptionToStreamOptions	requiresLeader(boolean value)	If true, requires the request to be performed by the leader of the cluster.
UpdatePersistentSubscriptionToStreamOptions	resolveLinks(boolean value)	Deprecated. prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos(boolean value)
UpdatePersistentSubscriptionToStreamOptions	resolveLinkTos()	Resolve linkTo events to their linked events.
UpdatePersistentSubscriptionToStreamOptions	resolveLinkTos(boolean value)	Whether the subscription should resolve linkTo events to their linked events.
UpdatePersistentSubscriptionToStreamOptions	startFrom(long revision)	Starts the persistent subscription from a specific revision number.

Methods inherited from class java.lang.Object

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

Method Details

get

public static UpdatePersistentSubscriptionToStreamOptions get()

Returns options with default values.

from

public static UpdatePersistentSubscriptionToStreamOptions from(PersistentSubscriptionToStreamSettings settings)

Returns options from a persistent subscription to stream settings.

See Also:

• PersistentSubscriptionToStreamSettings

fromStart

public UpdatePersistentSubscriptionToStreamOptions fromStart()

Starts the persistent subscription from the beginning of the stream.

fromEnd

public UpdatePersistentSubscriptionToStreamOptions fromEnd()

Starts the persistent subscription from the end of the stream.

startFrom

public UpdatePersistentSubscriptionToStreamOptions startFrom(long revision)

Starts the persistent subscription from a specific revision number.

enableLinkResolution

@Deprecated
public UpdatePersistentSubscriptionToStreamOptions enableLinkResolution()

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos()

disableLinkResolution

@Deprecated
public UpdatePersistentSubscriptionToStreamOptions disableLinkResolution()

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.notResolveLinkTos()

resolveLinks

@Deprecated
public UpdatePersistentSubscriptionToStreamOptions resolveLinks(boolean value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos(boolean value)

resolveLinkTos

public UpdatePersistentSubscriptionToStreamOptions resolveLinkTos(boolean value)

Whether the subscription should resolve linkTo events to their linked events. Default: false.

resolveLinkTos

public UpdatePersistentSubscriptionToStreamOptions resolveLinkTos()

Resolve linkTo events to their linked events.

notResolveLinkTos

public UpdatePersistentSubscriptionToStreamOptions notResolveLinkTos()

Don't resolve linkTo events to their linked events.

enableExtraStatistics

public UpdatePersistentSubscriptionToStreamOptions enableExtraStatistics()

Enable tracking of latency statistics on this subscription.

disableExtraStatistics

public UpdatePersistentSubscriptionToStreamOptions disableExtraStatistics()

Disable tracking of latency statistics on this subscription.

extraStatistics

public UpdatePersistentSubscriptionToStreamOptions extraStatistics(boolean value)

Whether to track latency statistics on this subscription. Default: false.

checkpointAfter

public UpdatePersistentSubscriptionToStreamOptions checkpointAfter(Duration value)

The amount of time to try to checkpoint after. Default: 2 seconds.

checkpointAfterInMs

public UpdatePersistentSubscriptionToStreamOptions checkpointAfterInMs(int value)

The amount of time in milliseconds to try to checkpoint after. Default: 2 seconds.

historyBufferSize

public UpdatePersistentSubscriptionToStreamOptions historyBufferSize(int value)

The number of events to cache when catching up. Default: 500.

liveBufferSize

public UpdatePersistentSubscriptionToStreamOptions liveBufferSize(int value)

The size of the buffer (in-memory) listening to live messages as they happen before paging occurs. Default: 500.

maxCheckpointCount

@Deprecated
public UpdatePersistentSubscriptionToStreamOptions maxCheckpointCount(int value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointUpperBound(int value)

checkpointUpperBound

public UpdatePersistentSubscriptionToStreamOptions checkpointUpperBound(int value)

The maximum number of messages not checkpointed before forcing a checkpoint. Default: 1000.

minCheckpointCount

@Deprecated
public UpdatePersistentSubscriptionToStreamOptions minCheckpointCount(int value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointLowerBound(int value)

checkpointLowerBound

public UpdatePersistentSubscriptionToStreamOptions checkpointLowerBound(int value)

The minimum number of messages to process before a checkpoint may be written. Default: 10.

maxSubscriberCount

public UpdatePersistentSubscriptionToStreamOptions maxSubscriberCount(int value)

The maximum number of subscribers allowed. Default: 0 (Unbounded).

maxRetryCount

public UpdatePersistentSubscriptionToStreamOptions maxRetryCount(int value)

The maximum number of retries (due to timeout) before a message is considered to be parked. Default: 10.

messageTimeout

public UpdatePersistentSubscriptionToStreamOptions messageTimeout(Duration value)

The amount of time after which to consider a message as timed out and retried. Default: 30 seconds.

messageTimeoutInMs

public UpdatePersistentSubscriptionToStreamOptions messageTimeoutInMs(int value)

The amount of time in milliseconds after which to consider a message as timed out and retried. Default: 30 seconds.

readBatchSize

public UpdatePersistentSubscriptionToStreamOptions readBatchSize(int value)

The number of events read at a time when catching up. Default: 20.

namedConsumerStrategy

public UpdatePersistentSubscriptionToStreamOptions namedConsumerStrategy(NamedConsumerStrategy value)

The strategy to use for distributing events to client consumers.

authenticated

public UpdatePersistentSubscriptionToStreamOptions authenticated(UserCredentials credentials)

Sets user credentials for the request

Parameters:

credentials -

Returns:

updated options

See Also:

• UserCredentials

authenticated

public UpdatePersistentSubscriptionToStreamOptions authenticated(String login,
 String password)

Sets user credentials for the request

Parameters:

login -

password -

Returns:

updated options

requiresLeader

public UpdatePersistentSubscriptionToStreamOptions requiresLeader()

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

Returns:

updated options

notRequireLeader

public UpdatePersistentSubscriptionToStreamOptions notRequireLeader()

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

Returns:

updated options

requiresLeader

public UpdatePersistentSubscriptionToStreamOptions requiresLeader(boolean value)

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

Parameters:

value -

Returns:

updated options

deadline

public UpdatePersistentSubscriptionToStreamOptions deadline(long durationInMs)

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

Parameters:

durationInMs -

Returns:

header

public UpdatePersistentSubscriptionToStreamOptions header(String key,
 String value)

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