Table of Contents

Interface ICloudNativeOutboxStoreBatch

Namespace
Excalibur.Data.CloudNative
Assembly
Excalibur.Data.Abstractions.dll

Provides batch and administrative operations for cloud-native outbox stores. Implementations should implement this alongside ICloudNativeOutboxStore.

public interface ICloudNativeOutboxStoreBatch

Methods

AddBatchAsync(IEnumerable<CloudOutboxMessage>, IPartitionKey, CancellationToken)

Adds multiple messages in a transactional batch.

Task<CloudBatchResult> AddBatchAsync(IEnumerable<CloudOutboxMessage> messages, IPartitionKey partitionKey, CancellationToken cancellationToken)

Parameters

messages IEnumerable<CloudOutboxMessage>
partitionKey IPartitionKey
cancellationToken CancellationToken

Returns

Task<CloudBatchResult>

CleanupOldMessagesAsync(IPartitionKey, TimeSpan, CancellationToken)

Deletes published messages older than the retention period.

Task<CloudCleanupResult> CleanupOldMessagesAsync(IPartitionKey partitionKey, TimeSpan retentionPeriod, CancellationToken cancellationToken)

Parameters

partitionKey IPartitionKey
retentionPeriod TimeSpan
cancellationToken CancellationToken

Returns

Task<CloudCleanupResult>

IncrementRetryCountAsync(string, IPartitionKey, string?, CancellationToken)

Increments the retry count for a failed message.

Task<CloudOperationResult> IncrementRetryCountAsync(string messageId, IPartitionKey partitionKey, string? errorMessage, CancellationToken cancellationToken)

Parameters

messageId string
partitionKey IPartitionKey
errorMessage string
cancellationToken CancellationToken

Returns

Task<CloudOperationResult>

MarkBatchAsPublishedAsync(IEnumerable<string>, IPartitionKey, CancellationToken)

Marks multiple messages as published in a batch.

Task<CloudBatchResult> MarkBatchAsPublishedAsync(IEnumerable<string> messageIds, IPartitionKey partitionKey, CancellationToken cancellationToken)

Parameters

messageIds IEnumerable<string>
partitionKey IPartitionKey
cancellationToken CancellationToken

Returns

Task<CloudBatchResult>