Table of Contents

Interface IElasticSearchOutboxBuilder

Namespace
Excalibur.Outbox.ElasticSearch
Assembly
Excalibur.Outbox.ElasticSearch.dll

Fluent builder for configuring Elasticsearch outbox settings.

public interface IElasticSearchOutboxBuilder

Methods

BindConfiguration(string)

Binds options from an IConfiguration section.

IElasticSearchOutboxBuilder BindConfiguration(string sectionPath)

Parameters

sectionPath string

Returns

IElasticSearchOutboxBuilder

Client(ElasticsearchClient)

Sets a pre-configured Elastic.Clients.Elasticsearch.ElasticsearchClient instance.

IElasticSearchOutboxBuilder Client(ElasticsearchClient client)

Parameters

client ElasticsearchClient

Returns

IElasticSearchOutboxBuilder

ClientFactory(Func<IServiceProvider, ElasticsearchClient>)

Sets a factory that resolves an Elastic.Clients.Elasticsearch.ElasticsearchClient from DI.

IElasticSearchOutboxBuilder ClientFactory(Func<IServiceProvider, ElasticsearchClient> factory)

Parameters

factory Func<IServiceProvider, ElasticsearchClient>

Returns

IElasticSearchOutboxBuilder

CloudId(string)

Sets the Elastic Cloud ID.

IElasticSearchOutboxBuilder CloudId(string cloudId)

Parameters

cloudId string

Returns

IElasticSearchOutboxBuilder

IndexName(string)

Sets the index name for outbox entries.

IElasticSearchOutboxBuilder IndexName(string name)

Parameters

name string

Returns

IElasticSearchOutboxBuilder

NodeUri(Uri)

Sets a single-node URI.

IElasticSearchOutboxBuilder NodeUri(Uri uri)

Parameters

uri Uri

Returns

IElasticSearchOutboxBuilder

NodeUris(IEnumerable<Uri>)

Sets cluster node URIs.

IElasticSearchOutboxBuilder NodeUris(IEnumerable<Uri> uris)

Parameters

uris IEnumerable<Uri>

Returns

IElasticSearchOutboxBuilder

SourceSerializer(IJsonTypeInfoResolver)

Supplies application metadata for framework-owned clients.

IElasticSearchOutboxBuilder SourceSerializer(IJsonTypeInfoResolver resolver)

Parameters

resolver IJsonTypeInfoResolver

Generated metadata for custom headers or other source documents.

Returns

IElasticSearchOutboxBuilder

The builder for chaining.

Remarks

The framework always includes its persisted document metadata. There is no implicit reflection fallback. Managed applications can explicitly supply a reflection resolver for arbitrary objects. This setting does not replace the serializer of a borrowed Elastic.Clients.Elasticsearch.ElasticsearchClient; configure that client with ElasticsearchOutboxSerializer when constructing it.