EventStoreOperationsScavengeMixin mixin

Superclass Constraints
Mixin Applications

Properties

api → Versions
Get api versions. If verify is not invoked, Versions.server is null.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isGrpcWeb → bool
True if this client is using grpc-web protocol
finalinherited
leader → EndPoint
Get EndPoint for last known leader node. If connecting to a single node, this returns EventStoreClientSettings.singleNode.
no setterinherited
options → CallOptions?
GRPC CallOptions instance
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
settings → EventStoreClientSettings
Connection name supplied as metadata to server
finalinherited
supportsClientStreamingRpc → bool
Check if grpc protocol supports client streaming See https://github.com/grpc/grpc-web/blob/master/doc/interop-test-descriptions.md
no setterinherited

Methods

$createChannel(EndPoint endPoint) → GrpcOrGrpcWebClientChannel
inherited
$getClient(EndPoint node) → Future<OperationsClient>
inherited
discover() → Future<EndPoint>
Discover node EndPoint given current EventStoreClientSettings.nodePreference.
inherited
isFeatureSupported(ApiFeature feature) → bool
Check if given feature is supported by api.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shutdown() → Future<void>
Shutdown all channels
inherited
start({required EndPoint node, int threadCount = 1, int startFromChunk = 0, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<ScavengeResult>
Starts a scavenge operation. Use parameter threadCount to control the number of threads to use. Use parameter startFromChunk to control where to start scavenging. Use parameter node to specify which node to start scavenge. Returns a ScavengeResult with ScavengeResult.state and ScavengeResult.scavengeId. Throws an ArgumentOutOfRangeException on negative parameters.
stop({required EndPoint node, required String scavengeId, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<ScavengeResult>
Start scavenge operation with given scavengeId. Use parameter node to specify which node to stop scavenge. Throws a ScavengeNotFoundException if scavengeId does not exist in node.
toString() → String
A string representation of this object.
inherited
verify() → Future<void>
Verify that EventStoreClientSettings.apiVersion is compatible with server version. Throws a UnsupportedApiVersionException if MemberInfo.apiVersion is incompatible with requested EventStoreClientSettings.apiVersion.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited