Package com.eventstore.dbclient

Class UpdatePersistentSubscriptionToAllOptions

java.lang.Object

com.eventstore.dbclient.UpdatePersistentSubscriptionToAllOptions

public class UpdatePersistentSubscriptionToAllOptions
extends Object

Options of the update persistent subscription to $all stream request.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

get

public static UpdatePersistentSubscriptionToAllOptions get()

Returns options with default values.

from

public static UpdatePersistentSubscriptionToAllOptions from(PersistentSubscriptionToAllSettings settings)

Returns options from a persistent subscription to $all settings.

See Also:

• PersistentSubscriptionToAllSettings

fromStart

public UpdatePersistentSubscriptionToAllOptions fromStart()

Starts the persistent subscription from the beginning of the $all stream.

fromEnd

public UpdatePersistentSubscriptionToAllOptions fromEnd()

Starts the persistent subscription from the end of the $all stream.

startFrom

public UpdatePersistentSubscriptionToAllOptions startFrom(Position position)

Starts the persistent subscription from a specific transaction log position.

startFrom

public UpdatePersistentSubscriptionToAllOptions startFrom(long unsignedPrepare,
 long unsignedCommit)

Starts the persistent subscription from a specific transaction log position.

enableLinkResolution

@Deprecated
public UpdatePersistentSubscriptionToAllOptions enableLinkResolution()

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos()

disableLinkResolution

@Deprecated
public UpdatePersistentSubscriptionToAllOptions disableLinkResolution()

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.notResolveLinkTos()

resolveLinks

@Deprecated
public UpdatePersistentSubscriptionToAllOptions resolveLinks(boolean value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos(boolean value)

resolveLinkTos

public UpdatePersistentSubscriptionToAllOptions resolveLinkTos(boolean value)

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

resolveLinkTos

public UpdatePersistentSubscriptionToAllOptions resolveLinkTos()

Resolve linkTo events to their linked events.

notResolveLinkTos

public UpdatePersistentSubscriptionToAllOptions notResolveLinkTos()

Don't resolve linkTo events to their linked events.

enableExtraStatistics

public UpdatePersistentSubscriptionToAllOptions enableExtraStatistics()

Enable tracking of latency statistics on this subscription.

disableExtraStatistics

public UpdatePersistentSubscriptionToAllOptions disableExtraStatistics()

Disable tracking of latency statistics on this subscription.

extraStatistics

public UpdatePersistentSubscriptionToAllOptions extraStatistics(boolean value)

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

checkpointAfter

public UpdatePersistentSubscriptionToAllOptions checkpointAfter(Duration value)

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

checkpointAfterInMs

public UpdatePersistentSubscriptionToAllOptions checkpointAfterInMs(int value)

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

historyBufferSize

public UpdatePersistentSubscriptionToAllOptions historyBufferSize(int value)

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

liveBufferSize

public UpdatePersistentSubscriptionToAllOptions 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 UpdatePersistentSubscriptionToAllOptions maxCheckpointCount(int value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointUpperBound(int value)

checkpointUpperBound

public UpdatePersistentSubscriptionToAllOptions checkpointUpperBound(int value)

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

minCheckpointCount

@Deprecated
public UpdatePersistentSubscriptionToAllOptions minCheckpointCount(int value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointLowerBound(int value)

checkpointLowerBound

public UpdatePersistentSubscriptionToAllOptions checkpointLowerBound(int value)

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

maxSubscriberCount

public UpdatePersistentSubscriptionToAllOptions maxSubscriberCount(int value)

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

maxRetryCount

public UpdatePersistentSubscriptionToAllOptions maxRetryCount(int value)

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

messageTimeout

public UpdatePersistentSubscriptionToAllOptions messageTimeout(Duration value)

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

messageTimeoutInMs

public UpdatePersistentSubscriptionToAllOptions 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 UpdatePersistentSubscriptionToAllOptions readBatchSize(int value)

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

namedConsumerStrategy

public UpdatePersistentSubscriptionToAllOptions namedConsumerStrategy(NamedConsumerStrategy value)

The strategy to use for distributing events to client consumers.

authenticated

public UpdatePersistentSubscriptionToAllOptions authenticated(UserCredentials credentials)

Sets user credentials for the request

Parameters:

credentials -

Returns:

updated options

See Also:

• UserCredentials

authenticated

public UpdatePersistentSubscriptionToAllOptions authenticated(String login,
 String password)

Sets user credentials for the request

Parameters:

login -

password -

Returns:

updated options

requiresLeader

public UpdatePersistentSubscriptionToAllOptions requiresLeader()

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

Returns:

updated options

notRequireLeader

public UpdatePersistentSubscriptionToAllOptions notRequireLeader()

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

Returns:

updated options

requiresLeader

public UpdatePersistentSubscriptionToAllOptions requiresLeader(boolean value)

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

Parameters:

value -

Returns:

updated options

deadline

public UpdatePersistentSubscriptionToAllOptions deadline(long durationInMs)

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

Parameters:

durationInMs -

Returns:

header

public UpdatePersistentSubscriptionToAllOptions header(String key,
 String value)

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