EventStoreClientSettings class
Constructors
-
EventStoreClientSettings({EndPoint? singleNode, bool useTls = true, String? connectionName, UserCredentials? defaultCredentials, Duration? batchAppendDeadline, List<
EndPoint> gossipSeeds = const [], TlsSetup tlsSetup = Defaults.TlsSetup, String apiVersion = ApiVersions.V20_LTS, int maxRetries = Defaults.MaxRetries, bool batchAppend = Defaults.BatchAppend, Duration gossipTimeout = Defaults.GossipTimeout, int batchAppendSize = Defaults.BatchAppendSize, NodePreference nodePreference = Defaults.NodePreference, Duration operationTimeout = Defaults.OperationTimeout, Duration keepAliveTimeout = Defaults.KeepAliveTimeout, Duration keepAliveInterval = Defaults.KeepAliveInterval, Duration discoveryInterval = Defaults.DiscoveryInterval, int maxDiscoverAttempts = Defaults.MaxDiscoverAttempts, EventStoreClientOperationOptions operationOptions = EventStoreClientOperationOptions.Default})
Properties
- address → Uri?
-
Get address to single node
no setter
- apiVersion → String
-
Settings are compatible with given EventStoreDB apiVersion
final
- batchAppend → bool
-
If true, use batch append operation.
Only available with version EventStoreDB 21.6.x and above
final
- batchAppendDeadline → Duration?
-
The batch append operation deadline.
Only available with version EventStoreDB v21_LTS and above
final
- batchAppendSize → int
-
Batch append size used when batchAppend is true.
Only available with version EventStoreDB v21_LTS and above
final
- connectionName → String
-
Connection name supplied as metadata to server
final
- defaultCredentials → UserCredentials?
-
Optional UserCredentials to use if none
have been supplied to the operation.
final
- discoveryInterval → Duration
-
The polling interval used to discover the EndPoint
final
-
gossipSeeds
→ List<
EndPoint> -
An array of
EndPoints used to seed gossip.final - gossipTimeout → Duration
-
The Duration after which an attempt to discover gossip will fail.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isBasicAuth → bool
-
Check if basic authentication should be used
no setter
- isSingleNode → bool
-
Check if connection is on a single node
no setter
- keepAliveInterval → Duration
-
After a duration of keepAliveInterval (in milliseconds), if the server
doesn't see any activity, it pings the client to see if the transport is
still alive.
final
- keepAliveTimeout → Duration
-
After having pinged for keepalive check, the server waits for a duration
of keepAliveTimeout (in milliseconds). If the connection doesn't have
any activity even after that, it gets closed.
final
- maxDiscoverAttempts → int
-
The maximum number of times to attempt EndPoint discovery.
final
- maxRetries → int
-
Maximum number of reties before transient errors from
servers throws an error. By default, only status code
only gRPC status code
UNAVAILABLE is retried.
final
- nodePreference → NodePreference
-
Get NodePreference
final
- operationOptions → EventStoreClientOperationOptions
-
The default EventStoreClientOperationOptions to use.
final
- operationTimeout → Duration
-
Get operation timeout
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- singleNode → EndPoint?
-
EndPoint to single node
final
- tlsSetup → TlsSetup
-
tlsSetup configures secure connection behaviour and security context.
final
- useTls → bool
-
True if communicating over a secure channel; otherwise false.
final
Methods
-
copyWith(
{bool? useTls, bool? batchAppend, String? apiVersion, TlsSetup? tlsSetup, EndPoint? singleNode, int? batchAppendSize, String? connectionName, Duration? gossipTimeout, int? maxDiscoverAttempts, List< EndPoint> ? gossipSeeds, Duration? batchAppendDeadline, NodePreference? nodePreference, UserCredentials? defaultCredentials, EventStoreClientOperationOptions? operationOptions, Duration? operationTimeout = Defaults.OperationTimeout, Duration? keepAliveTimeout = Defaults.KeepAliveTimeout, Duration? keepAliveInterval = Defaults.KeepAliveInterval, Duration? discoveryInterval = Defaults.DiscoveryInterval}) → EventStoreClientSettings - Copy EventStoreClientSettings and overwrite given values
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- V20 → EventStoreClientSettings
-
Get default settings for EventStoreDB v20.x
final
- V20_LTS → EventStoreClientSettings
-
Get default settings for EventStoreDB v20.x LTS version
final
- V21 → EventStoreClientSettings
-
Get default settings for EventStoreDB v21.x
final
- V21_LTS → EventStoreClientSettings
-
Get default settings for EventStoreDB v21.x LTS version
final
Static Methods
-
parse(
String connectionString) → EventStoreClientSettings -
Parse
connectionStringinto EventStoreClientSettings. If the connectionString string is not valid as a Uri, a FormatException is thrown.