Class ProducerEndpointConfiguration

The producer configuration.

Inheritance

object

EndpointConfiguration

ProducerEndpointConfiguration

ProducerEndpointConfiguration<TEndpoint>

Implements

IEquatable<EndpointConfiguration>

IEquatable<ProducerEndpointConfiguration>

Inherited Members

EndpointConfiguration.Validate()

EndpointConfiguration.FriendlyName

EndpointConfiguration.RawName

EndpointConfiguration.DisplayName

EndpointConfiguration.MessageValidationMode

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Silverback.Messaging.Configuration

Assembly: Silverback.Integration.dll

Syntax

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

Constructors

ProducerEndpointConfiguration()

The producer configuration.

Declaration

protected ProducerEndpointConfiguration()

ProducerEndpointConfiguration(ProducerEndpointConfiguration)

The producer configuration.

Declaration

protected ProducerEndpointConfiguration(ProducerEndpointConfiguration original)

Parameters

Type	Name	Description
ProducerEndpointConfiguration	original

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.

Declaration

public ChunkSettings? Chunk { get; init; }

Property Value

Type	Description
ChunkSettings

EnableSubscribing

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

Declaration

public bool EnableSubscribing { get; init; }

Property Value

Type	Description
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.

Declaration

public IEncryptionSettings? Encryption { get; init; }

Property Value

Type	Description
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.

Declaration

public IProducerEndpointResolver EndpointResolver { get; init; }

Property Value

Type	Description
IProducerEndpointResolver

EqualityContract

The producer configuration.

Declaration

protected override Type EqualityContract { get; }

Property Value

Type	Description
Type

Overrides

EndpointConfiguration.EqualityContract

Filter

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

Declaration

public IOutboundMessageFilter? Filter { get; init; }

Property Value

Type	Description
IOutboundMessageFilter

MessageEnrichers

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

Declaration

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

Property Value

Type	Description
IValueReadOnlyCollection<IOutboundMessageEnricher>

Serializer

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

Declaration

public IMessageSerializer Serializer { get; init; }

Property Value

Type	Description
IMessageSerializer

Strategy

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

Declaration

public IProduceStrategy Strategy { get; init; }

Property Value

Type	Description
IProduceStrategy

Methods

Equals(EndpointConfiguration?)

The producer configuration.

Declaration

public override sealed bool Equals(EndpointConfiguration? other)

Parameters

Type	Name	Description
EndpointConfiguration	other

Returns

Type	Description
bool

Overrides

EndpointConfiguration.Equals(EndpointConfiguration?)

Equals(ProducerEndpointConfiguration?)

The producer configuration.

Declaration

public virtual bool Equals(ProducerEndpointConfiguration? other)

Parameters

Type	Name	Description
ProducerEndpointConfiguration	other

Returns

Type	Description
bool

Equals(object?)

The producer configuration.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

EndpointConfiguration.Equals(object?)

GetHashCode()

The producer configuration.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

EndpointConfiguration.GetHashCode()

PrintMembers(StringBuilder)

The producer configuration.

Declaration

protected override bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
StringBuilder	builder

Returns

Type	Description
bool

Overrides

EndpointConfiguration.PrintMembers(StringBuilder)

ToString()

The producer configuration.

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

EndpointConfiguration.ToString()

ValidateCore()

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

Declaration

protected override void ValidateCore()

Overrides

EndpointConfiguration.ValidateCore()

Operators

operator ==(ProducerEndpointConfiguration?, ProducerEndpointConfiguration?)

The producer configuration.

Declaration

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

Parameters

Type	Name	Description
ProducerEndpointConfiguration	left
ProducerEndpointConfiguration	right

Returns

Type	Description
bool

operator !=(ProducerEndpointConfiguration?, ProducerEndpointConfiguration?)

The producer configuration.

Declaration

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

Parameters

Type	Name	Description
ProducerEndpointConfiguration	left
ProducerEndpointConfiguration	right

Returns

Type	Description
bool

Implements

IEquatable<T>

IEquatable<T>