Table of Contents

Interface IMessageConfiguration

Namespace
AWS.Messaging.Configuration
Assembly
AWS.Messaging.dll

Interface for the message configuration.

public interface IMessageConfiguration

Properties

BackoffPolicy

Sets the Backoff Policy to be used with AWS.Messaging.Services.Backoff.BackoffHandler.

BackoffPolicy BackoffPolicy { get; set; }

Property Value

BackoffPolicy

CappedExponentialBackoffOptions

Holds an instance of CappedExponentialBackoffOptions to control the behavior of AWS.Messaging.Services.Backoff.Policies.CappedExponentialBackoffPolicy.

CappedExponentialBackoffOptions CappedExponentialBackoffOptions { get; }

Property Value

CappedExponentialBackoffOptions

IntervalBackoffOptions

Holds an instance of IntervalBackoffOptions to control the behavior of AWS.Messaging.Services.Backoff.Policies.IntervalBackoffPolicy.

IntervalBackoffOptions IntervalBackoffOptions { get; }

Property Value

IntervalBackoffOptions

LogMessageContent

Controls the visibility of data messages in the logging framework, exception handling and other areas. If this is enabled, messages sent by this framework will be visible in plain text across the framework's components. This means any sensitive user data sent by this framework will be visible in logs, any exceptions thrown and others.

bool LogMessageContent { get; set; }

Property Value

bool

MessagePollerConfigurations

List of configurations for subscriber to poll for messages from an AWS service endpoint.

IList<IMessagePollerConfiguration> MessagePollerConfigurations { get; set; }

Property Value

IList<IMessagePollerConfiguration>

PollingControlToken

Holds an instance of PollingControlToken to control behaviour of IMessagePoller

PollingControlToken PollingControlToken { get; }

Property Value

PollingControlToken

PublisherMappings

Maps the message types to a publisher configuration

IList<PublisherMapping> PublisherMappings { get; }

Property Value

IList<PublisherMapping>

SerializationCallbacks

Holds instances of ISerializationCallback that lets users inject their own metadata to incoming and outgoing messages.

IList<ISerializationCallback> SerializationCallbacks { get; }

Property Value

IList<ISerializationCallback>

SerializationOptions

Holds an instance of SerializationOptions to control the serialization/de-serialization of the application message.

SerializationOptions SerializationOptions { get; }

Property Value

SerializationOptions

Source

The relative or absolute Uri to be used as a message source. This source is added globally to any message sent through the framework.

string? Source { get; set; }

Property Value

string

SourceSuffix

A suffix to append to the user-defined Source or computed by the framework in the absence of a user-defined one.

string? SourceSuffix { get; set; }

Property Value

string

SubscriberMappings

Maps the message types to a subscriber configuration

IList<SubscriberMapping> SubscriberMappings { get; }

Property Value

IList<SubscriberMapping>

Methods

GetPublisherMapping(Type)

Returns back the publisher mapping for the given message type.

PublisherMapping? GetPublisherMapping(Type messageType)

Parameters

messageType Type

The Type of the message

Returns

PublisherMapping

The PublisherMapping containing routing info for the specified message type.

GetSubscriberMapping(string)

Returns back the subscriber mapping for the given message type identifier.

SubscriberMapping? GetSubscriberMapping(string messageTypeIdentifier)

Parameters

messageTypeIdentifier string

The language agnostic identifier for the application message

Returns

SubscriberMapping

The SubscriberMapping containing routing info for the specified message type.

GetSubscriberMapping(Type)

Returns back the subscriber mapping for the given message type.

SubscriberMapping? GetSubscriberMapping(Type messageType)

Parameters

messageType Type

The Type of the message

Returns

SubscriberMapping

The SubscriberMapping containing routing info for the specified message type.