Package com.eventstore.dbclient

Class CreatePersistentSubscriptionToAllOptions

java.lang.Object

com.eventstore.dbclient.CreatePersistentSubscriptionToAllOptions

public class CreatePersistentSubscriptionToAllOptions
extends Object

Options of create persistent subscription to $all request.

Method Summary

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

Returns options with default values.

filter

public CreatePersistentSubscriptionToAllOptions filter(SubscriptionFilter filter)

Applies a server-side filter to determine if an event of the subscription should be yielded.

fromStart

public CreatePersistentSubscriptionToAllOptions fromStart()

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

fromEnd

public CreatePersistentSubscriptionToAllOptions fromEnd()

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

startFrom

public CreatePersistentSubscriptionToAllOptions startFrom(Position position)

Starts the subscription from the given transaction log position.

Parameters:

position - a transaction log position.

See Also:

• Position

startFrom

public CreatePersistentSubscriptionToAllOptions startFrom(long unsignedPrepare,
 long unsignedCommit)

Starts the subscription from the given transaction log position.

See Also:

• Position

enableLinkResolution

@Deprecated
public CreatePersistentSubscriptionToAllOptions enableLinkResolution()

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos()

disableLinkResolution

@Deprecated
public CreatePersistentSubscriptionToAllOptions disableLinkResolution()

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.notResolveLinkTos()

resolveLinks

@Deprecated
public CreatePersistentSubscriptionToAllOptions resolveLinks(boolean value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos(boolean value)

resolveLinkTos

public CreatePersistentSubscriptionToAllOptions resolveLinkTos(boolean value)

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

resolveLinkTos

public CreatePersistentSubscriptionToAllOptions resolveLinkTos()

Resolve linkTo events to their linked events.

notResolveLinkTos

public CreatePersistentSubscriptionToAllOptions notResolveLinkTos()

Don't resolve linkTo events to their linked events.

enableExtraStatistics

public CreatePersistentSubscriptionToAllOptions enableExtraStatistics()

Enable tracking of latency statistics on this subscription.

disableExtraStatistics

public CreatePersistentSubscriptionToAllOptions disableExtraStatistics()

Disable tracking of latency statistics on this subscription.

extraStatistics

public CreatePersistentSubscriptionToAllOptions extraStatistics(boolean value)

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

checkpointAfter

public CreatePersistentSubscriptionToAllOptions checkpointAfter(Duration value)

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

checkpointAfterInMs

public CreatePersistentSubscriptionToAllOptions checkpointAfterInMs(int value)

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

historyBufferSize

public CreatePersistentSubscriptionToAllOptions historyBufferSize(int value)

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

liveBufferSize

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

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointUpperBound(int value)

checkpointUpperBound

public CreatePersistentSubscriptionToAllOptions checkpointUpperBound(int value)

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

minCheckpointCount

@Deprecated
public CreatePersistentSubscriptionToAllOptions minCheckpointCount(int value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointLowerBound(int value)

checkpointLowerBound

public CreatePersistentSubscriptionToAllOptions checkpointLowerBound(int value)

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

maxSubscriberCount

public CreatePersistentSubscriptionToAllOptions maxSubscriberCount(int value)

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

maxRetryCount

public CreatePersistentSubscriptionToAllOptions maxRetryCount(int value)

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

messageTimeout

public CreatePersistentSubscriptionToAllOptions messageTimeout(Duration value)

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

messageTimeoutInMs

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

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

namedConsumerStrategy

public CreatePersistentSubscriptionToAllOptions namedConsumerStrategy(NamedConsumerStrategy value)

The strategy to use for distributing events to client consumers.

authenticated

public CreatePersistentSubscriptionToAllOptions authenticated(UserCredentials credentials)

Sets user credentials for the request

Parameters:

credentials -

Returns:

updated options

See Also:

• UserCredentials

authenticated

public CreatePersistentSubscriptionToAllOptions authenticated(String login,
 String password)

Sets user credentials for the request

Parameters:

login -

password -

Returns:

updated options

requiresLeader

public CreatePersistentSubscriptionToAllOptions requiresLeader()

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

Returns:

updated options

notRequireLeader

public CreatePersistentSubscriptionToAllOptions notRequireLeader()

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

Returns:

updated options

requiresLeader

public CreatePersistentSubscriptionToAllOptions requiresLeader(boolean value)

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

Parameters:

value -

Returns:

updated options

deadline

public CreatePersistentSubscriptionToAllOptions deadline(long durationInMs)

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

Parameters:

durationInMs -

Returns:

header

public CreatePersistentSubscriptionToAllOptions header(String key,
 String value)

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