Interface IEndpoint

Represents a message broker endpoint to connect to (such as a Kafka topic or RabbitMQ queue or exchange).

Namespace: Silverback.Messaging

Assembly: Silverback.Integration.dll

Syntax

public interface IEndpoint

Properties

DisplayName

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

Declaration

string DisplayName { get; }

Property Value

Type	Description
string

Encryption

Gets the encryption settings. This optional settings enables the end-to-end message encryption.

When enabled the messages are transparently encrypted by the producer and decrypted by the consumer.

Set it to null (default) to disable this feature.

Declaration

EncryptionSettings? Encryption { get; }

Property Value

Type	Description
EncryptionSettings

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

string? FriendlyName { get; }

Property Value

Type	Description
string

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.

Declaration

MessageValidationMode MessageValidationMode { get; }

Property Value

Type	Description
MessageValidationMode

Name

Gets a string identifying the endpoint (the topic, queue or exchange name).

Declaration

string Name { get; }

Property Value

Type	Description
string

Serializer

Gets the IMessageSerializer to be used to serialize or deserialize the messages being produced or consumed.

Declaration

IMessageSerializer Serializer { get; }

Property Value

Type	Description
IMessageSerializer

Methods

Validate()

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

Declaration

void Validate()