Table of Contents

Class OpenSearchDeadLetterHandler

Namespace
Excalibur.Data.OpenSearch
Assembly
Excalibur.Data.OpenSearch.dll

Handles dead letter messages for OpenSearch operations.

public sealed class OpenSearchDeadLetterHandler
Inheritance
OpenSearchDeadLetterHandler
Inherited Members

Remarks

Initializes a new instance of the OpenSearchDeadLetterHandler class.

Constructors

OpenSearchDeadLetterHandler(OpenSearchClient, IOptions<OpenSearchDeadLetterOptions>, ILogger<OpenSearchDeadLetterHandler>)

Handles dead letter messages for OpenSearch operations.

public OpenSearchDeadLetterHandler(OpenSearchClient client, IOptions<OpenSearchDeadLetterOptions> options, ILogger<OpenSearchDeadLetterHandler> logger)

Parameters

client OpenSearchClient

The OpenSearch client.

options IOptions<OpenSearchDeadLetterOptions>

Dead letter handler options.

logger ILogger<OpenSearchDeadLetterHandler>

Logger instance.

Remarks

Initializes a new instance of the OpenSearchDeadLetterHandler class.

Methods

HandleDeadLetterAsync<T>(T, Exception, CancellationToken)

Handles a dead letter document.

public Task HandleDeadLetterAsync<T>(T document, Exception error, CancellationToken cancellationToken) where T : class

Parameters

document T

The document to handle.

error Exception

The error that caused the dead letter.

cancellationToken CancellationToken

Cancellation token.

Returns

Task

A task representing the asynchronous operation.

Type Parameters

T

The document type.

Exceptions

InvalidOperationException

Thrown when the dead letter document cannot be stored.

RetryDeadLettersAsync(string, int, CancellationToken)

Retries processing of dead letter documents.

public Task<int> RetryDeadLettersAsync(string indexName, int maxRetries, CancellationToken cancellationToken)

Parameters

indexName string

The dead letter index to retry from.

maxRetries int

Maximum number of documents to retry.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<int>

Number of successfully retried documents.