Package com.eventstore.dbclient

Class CreatePersistentSubscriptionToStreamOptions

java.lang.Object

com.eventstore.dbclient.CreatePersistentSubscriptionToStreamOptions

public class CreatePersistentSubscriptionToStreamOptions
extends Object

Options for the create persistent subscription to stream request.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

get

public static CreatePersistentSubscriptionToStreamOptions get()

Returns options with default values.

fromStart

public CreatePersistentSubscriptionToStreamOptions fromStart()

Starts the subscription from the beginning of the given stream.

fromEnd

public CreatePersistentSubscriptionToStreamOptions fromEnd()

Starts the subscription from the end of the given stream.

startFrom

public CreatePersistentSubscriptionToStreamOptions startFrom(long revision)

Starts the subscription from the given stream revision.

enableLinkResolution

@Deprecated
public CreatePersistentSubscriptionToStreamOptions enableLinkResolution()

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos()

disableLinkResolution

@Deprecated
public CreatePersistentSubscriptionToStreamOptions disableLinkResolution()

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.notResolveLinkTos()

resolveLinks

@Deprecated
public CreatePersistentSubscriptionToStreamOptions resolveLinks(boolean value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos(boolean value)

resolveLinkTos

public CreatePersistentSubscriptionToStreamOptions resolveLinkTos(boolean value)

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

resolveLinkTos

public CreatePersistentSubscriptionToStreamOptions resolveLinkTos()

Resolve linkTo events to their linked events.

notResolveLinkTos

public CreatePersistentSubscriptionToStreamOptions notResolveLinkTos()

Don't resolve linkTo events to their linked events.

enableExtraStatistics

public CreatePersistentSubscriptionToStreamOptions enableExtraStatistics()

Enable tracking of latency statistics on this subscription.

disableExtraStatistics

public CreatePersistentSubscriptionToStreamOptions disableExtraStatistics()

Disable tracking of latency statistics on this subscription.

extraStatistics

public CreatePersistentSubscriptionToStreamOptions extraStatistics(boolean value)

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

checkpointAfter

public CreatePersistentSubscriptionToStreamOptions checkpointAfter(Duration value)

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

checkpointAfterInMs

public CreatePersistentSubscriptionToStreamOptions checkpointAfterInMs(int value)

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

historyBufferSize

public CreatePersistentSubscriptionToStreamOptions historyBufferSize(int value)

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

liveBufferSize

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

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointUpperBound(int value)

checkpointUpperBound

public CreatePersistentSubscriptionToStreamOptions checkpointUpperBound(int value)

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

minCheckpointCount

@Deprecated
public CreatePersistentSubscriptionToStreamOptions minCheckpointCount(int value)

Deprecated.

prefer AbstractPersistentSubscriptionSettingsBuilder.checkpointLowerBound(int value)

checkpointLowerBound

public CreatePersistentSubscriptionToStreamOptions checkpointLowerBound(int value)

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

maxSubscriberCount

public CreatePersistentSubscriptionToStreamOptions maxSubscriberCount(int value)

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

maxRetryCount

public CreatePersistentSubscriptionToStreamOptions maxRetryCount(int value)

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

messageTimeout

public CreatePersistentSubscriptionToStreamOptions messageTimeout(Duration value)

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

messageTimeoutInMs

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

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

namedConsumerStrategy

public CreatePersistentSubscriptionToStreamOptions namedConsumerStrategy(NamedConsumerStrategy value)

The strategy to use for distributing events to client consumers.

authenticated

public CreatePersistentSubscriptionToStreamOptions authenticated(UserCredentials credentials)

Sets user credentials for the request

Parameters:

credentials -

Returns:

updated options

See Also:

• UserCredentials

authenticated

public CreatePersistentSubscriptionToStreamOptions authenticated(String login,
 String password)

Sets user credentials for the request

Parameters:

login -

password -

Returns:

updated options

requiresLeader

public CreatePersistentSubscriptionToStreamOptions requiresLeader()

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

Returns:

updated options

notRequireLeader

public CreatePersistentSubscriptionToStreamOptions notRequireLeader()

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

Returns:

updated options

requiresLeader

public CreatePersistentSubscriptionToStreamOptions requiresLeader(boolean value)

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

Parameters:

value -

Returns:

updated options

deadline

public CreatePersistentSubscriptionToStreamOptions deadline(long durationInMs)

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

Parameters:

durationInMs -

Returns:

header

public CreatePersistentSubscriptionToStreamOptions header(String key,
 String value)

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