Class EndpointConfiguration

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Inheritance

object

EndpointConfiguration

ConsumerEndpointConfiguration

ProducerEndpointConfiguration

Implements

IEquatable<EndpointConfiguration>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Silverback.Messaging.Configuration

Assembly: Silverback.Integration.dll

Syntax

public abstract record EndpointConfiguration : IEquatable<EndpointConfiguration>

Constructors

EndpointConfiguration()

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

protected EndpointConfiguration()

EndpointConfiguration(EndpointConfiguration)

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

protected EndpointConfiguration(EndpointConfiguration original)

Parameters

Type	Name	Description
EndpointConfiguration	original

Properties

DisplayName

Gets the name to be displayed in the human-targeted output (e.g. logs, health checks result, etc.).

Declaration

public virtual string DisplayName { get; }

Property Value

Type	Description
string

Remarks

The DisplayName is built joining the optional FriendlyName with the RawName.

EqualityContract

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

protected virtual Type EqualityContract { get; }

Property Value

Type	Description
Type

FriendlyName

Gets an optional friendly name to be used to identify the endpoint. This name can be used to filter or retrieve the endpoints and will also be included in the DisplayName, to be shown in the human-targeted output (e.g. logs, health checks result, etc.).

Declaration

public virtual string? FriendlyName { get; init; }

Property Value

Type	Description
string

Remarks

The DisplayName is built joining the optional FriendlyName with the RawName.

MessageValidationMode

Gets the message validation mode. This option can be used to specify if the messages have to be validated and whether an exception must be thrown if the message is not valid. The default is LogWarning.

Declaration

public virtual MessageValidationMode MessageValidationMode { get; init; }

Property Value

Type	Description
MessageValidationMode

RawName

Gets the raw endpoint name. This can be either the topic name for a static registration, the pattern used to create the actual endpoint name or simply a placeholder.

Declaration

public virtual string RawName { get; protected init; }

Property Value

Type	Description
string

Remarks

The DisplayName is built joining the optional FriendlyName with the RawName.

Methods

Equals(EndpointConfiguration?)

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

public virtual bool Equals(EndpointConfiguration? other)

Parameters

Type	Name	Description
EndpointConfiguration	other

Returns

Type	Description
bool

Equals(object?)

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

PrintMembers(StringBuilder)

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
StringBuilder	builder

Returns

Type	Description
bool

ToString()

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Validate()

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

Declaration

public void Validate()

ValidateCore()

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

Declaration

protected virtual void ValidateCore()

Operators

operator ==(EndpointConfiguration?, EndpointConfiguration?)

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

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

Parameters

Type	Name	Description
EndpointConfiguration	left
EndpointConfiguration	right

Returns

Type	Description
bool

operator !=(EndpointConfiguration?, EndpointConfiguration?)

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

Declaration

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

Parameters

Type	Name	Description
EndpointConfiguration	left
EndpointConfiguration	right

Returns

Type	Description
bool

Implements

IEquatable<T>