Class ProducerEndpointConfiguration

Namespace

Silverback.Messaging.Configuration

Assembly

Silverback.Integration.dll

The producer configuration.

public abstract record ProducerEndpointConfiguration : EndpointConfiguration, IEquatable<EndpointConfiguration>, IEquatable<ProducerEndpointConfiguration>

Inheritance

object

EndpointConfiguration

ProducerEndpointConfiguration

Implements

IEquatable<EndpointConfiguration>

IEquatable<ProducerEndpointConfiguration>

Derived

ProducerEndpointConfiguration<TEndpoint>

Inherited Members

EndpointConfiguration.Validate()

EndpointConfiguration.FriendlyName

EndpointConfiguration.RawName

EndpointConfiguration.DisplayName

EndpointConfiguration.MessageValidationMode

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ProducerEndpointConfiguration()

protected ProducerEndpointConfiguration()

ProducerEndpointConfiguration(ProducerEndpointConfiguration)

protected ProducerEndpointConfiguration(ProducerEndpointConfiguration original)

Parameters

original ProducerEndpointConfiguration

Properties

Chunk

Gets the message chunking settings. This option can be used to split large messages into smaller chunks. The default is null, which means that chunking is disabled.

public ChunkSettings? Chunk { get; init; }

Property Value

ChunkSettings

EnableSubscribing

Gets a value indicating whether the produced messages can be subscribed to. The default is false.

public bool EnableSubscribing { get; init; }

Property Value

bool

Encryption

Gets the encryption settings to be used to encrypt the messages. The default is null, which means that the messages are being sent in clear-text.

public IEncryptionSettings? Encryption { get; init; }

Property Value

IEncryptionSettings

EndpointResolver

Gets the IProducerEndpointResolver to be used to resolve the destination endpoint (e.g. the target topic and partition) for the message being produced.

public IProducerEndpointResolver EndpointResolver { get; init; }

Property Value

IProducerEndpointResolver

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

Filter

Gets the IOutboundMessageFilter to be used to filter out messages that should not be produced.

public IOutboundMessageFilter? Filter { get; init; }

Property Value

IOutboundMessageFilter

MessageEnrichers

Gets the collection of IOutboundMessageEnricher to be used to enrich the outbound message.

public IValueReadOnlyCollection<IOutboundMessageEnricher> MessageEnrichers { get; init; }

Property Value

IValueReadOnlyCollection<IOutboundMessageEnricher>

Serializer

Gets the IMessageSerializer to be used to serialize the messages being produced. The default is the JsonMessageSerializer.

public IMessageSerializer Serializer { get; init; }

Property Value

IMessageSerializer

Strategy

Gets the strategy to be used to produce the messages. The default is the DefaultProduceStrategy.

public IProduceStrategy Strategy { get; init; }

Property Value

IProduceStrategy

Methods

Equals(EndpointConfiguration?)

public override sealed bool Equals(EndpointConfiguration? other)

Parameters

other EndpointConfiguration

Returns

bool

Equals(ProducerEndpointConfiguration?)

public virtual bool Equals(ProducerEndpointConfiguration? other)

Parameters

other ProducerEndpointConfiguration

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

ValidateCore()

Validates the endpoint configuration and throws an BrokerConfigurationException if not valid.

protected override void ValidateCore()

Operators

operator ==(ProducerEndpointConfiguration?, ProducerEndpointConfiguration?)

public static bool operator ==(ProducerEndpointConfiguration? left, ProducerEndpointConfiguration? right)

Parameters

left ProducerEndpointConfiguration

right ProducerEndpointConfiguration

Returns

bool

operator !=(ProducerEndpointConfiguration?, ProducerEndpointConfiguration?)

public static bool operator !=(ProducerEndpointConfiguration? left, ProducerEndpointConfiguration? right)

Parameters

left ProducerEndpointConfiguration

right ProducerEndpointConfiguration

Returns

bool