Package com.eventstore.dbclient
Class UpdatePersistentSubscriptionToStreamOptions
java.lang.Object
com.eventstore.dbclient.UpdatePersistentSubscriptionToStreamOptions
Options of the update persistent subscription to stream request.
-
Method Summary
Modifier and TypeMethodDescriptionauthenticated(UserCredentials credentials) Sets user credentials for the requestauthenticated(String login, String password) Sets user credentials for the requestcheckpointAfter(Duration value) The amount of time to try to checkpoint after.checkpointAfterInMs(int value) The amount of time in milliseconds to try to checkpoint after.checkpointLowerBound(int value) The minimum number of messages to process before a checkpoint may be written.checkpointUpperBound(int value) The maximum number of messages not checkpointed before forcing a checkpoint.deadline(long durationInMs) A length of time (in milliseconds) to use for gRPC deadlines.Disable tracking of latency statistics on this subscription.Deprecated.Enable tracking of latency statistics on this subscription.Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos()extraStatistics(boolean value) Whether to track latency statistics on this subscription.from(PersistentSubscriptionToStreamSettings settings) Returns options from a persistent subscription to stream settings.fromEnd()Starts the persistent subscription from the end of the stream.Starts the persistent subscription from the beginning of the stream.get()Returns options with default values.Adds a custom HTTP header that will be added to the request.historyBufferSize(int value) The number of events to cache when catching up.liveBufferSize(int value) The size of the buffer (in-memory) listening to live messages as they happen before paging occurs.maxCheckpointCount(int value) Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.checkpointUpperBound(int value)maxRetryCount(int value) The maximum number of retries (due to timeout) before a message is considered to be parked.maxSubscriberCount(int value) The maximum number of subscribers allowed.messageTimeout(Duration value) The amount of time after which to consider a message as timed out and retried.messageTimeoutInMs(int value) The amount of time in milliseconds after which to consider a message as timed out and retried.minCheckpointCount(int value) Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.checkpointLowerBound(int value)The strategy to use for distributing events to client consumers.Do not require the request to be performed by the leader of the cluster.Don't resolve linkTo events to their linked events.readBatchSize(int value) The number of events read at a time when catching up.Requires the request to be performed by the leader of the cluster.requiresLeader(boolean value) If true, requires the request to be performed by the leader of the cluster.resolveLinks(boolean value) Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos(boolean value)Resolve linkTo events to their linked events.resolveLinkTos(boolean value) Whether the subscription should resolve linkTo events to their linked events.startFrom(long revision) Starts the persistent subscription from a specific revision number.
-
Method Details
-
get
Returns options with default values. -
from
public static UpdatePersistentSubscriptionToStreamOptions from(PersistentSubscriptionToStreamSettings settings) Returns options from a persistent subscription to stream settings.- See Also:
-
fromStart
Starts the persistent subscription from the beginning of the stream. -
fromEnd
Starts the persistent subscription from the end of the stream. -
startFrom
Starts the persistent subscription from a specific revision number. -
enableLinkResolution
Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos() -
disableLinkResolution
Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.notResolveLinkTos() -
resolveLinks
Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.resolveLinkTos(boolean value) -
resolveLinkTos
Whether the subscription should resolve linkTo events to their linked events. Default: false. -
resolveLinkTos
Resolve linkTo events to their linked events. -
notResolveLinkTos
Don't resolve linkTo events to their linked events. -
enableExtraStatistics
Enable tracking of latency statistics on this subscription. -
disableExtraStatistics
Disable tracking of latency statistics on this subscription. -
extraStatistics
Whether to track latency statistics on this subscription. Default: false. -
checkpointAfter
The amount of time to try to checkpoint after. Default: 2 seconds. -
checkpointAfterInMs
The amount of time in milliseconds to try to checkpoint after. Default: 2 seconds. -
historyBufferSize
The number of events to cache when catching up. Default: 500. -
liveBufferSize
The size of the buffer (in-memory) listening to live messages as they happen before paging occurs. Default: 500. -
maxCheckpointCount
Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.checkpointUpperBound(int value) -
checkpointUpperBound
The maximum number of messages not checkpointed before forcing a checkpoint. Default: 1000. -
minCheckpointCount
Deprecated.preferAbstractPersistentSubscriptionSettingsBuilder.checkpointLowerBound(int value) -
checkpointLowerBound
The minimum number of messages to process before a checkpoint may be written. Default: 10. -
maxSubscriberCount
The maximum number of subscribers allowed. Default: 0 (Unbounded). -
maxRetryCount
The maximum number of retries (due to timeout) before a message is considered to be parked. Default: 10. -
messageTimeout
The amount of time after which to consider a message as timed out and retried. Default: 30 seconds. -
messageTimeoutInMs
The amount of time in milliseconds after which to consider a message as timed out and retried. Default: 30 seconds. -
readBatchSize
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
Sets user credentials for the request- Parameters:
credentials-- Returns:
- updated options
- See Also:
-
authenticated
Sets user credentials for the request- Parameters:
login-password-- Returns:
- updated options
-
requiresLeader
Requires the request to be performed by the leader of the cluster.- Returns:
- updated options
-
notRequireLeader
Do not require the request to be performed by the leader of the cluster.- Returns:
- updated options
-
requiresLeader
If true, requires the request to be performed by the leader of the cluster.- Parameters:
value-- Returns:
- updated options
-
deadline
A length of time (in milliseconds) to use for gRPC deadlines.- Parameters:
durationInMs-- Returns:
-
header
Adds a custom HTTP header that will be added to the request.
-
AbstractPersistentSubscriptionSettingsBuilder.notResolveLinkTos()