Class OutboxDescriptor
Namespace: Cephalon.Abstractions.Data
Assembly: Cephalon.Abstractions.dll
Describes one outbox surface contributed to the active runtime.
public sealed class OutboxDescriptorInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”OutboxDescriptor(string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?, OutboxDispatchPolicyDescriptor?)
Section titled “ OutboxDescriptor(string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?, OutboxDispatchPolicyDescriptor?)”Creates a new outbox descriptor.
public OutboxDescriptor(string id, string displayName, string description, string sourceModuleId, string provider, string mode = "transactional-store", IReadOnlyList<string>? channelIds = null, IReadOnlyList<string>? tags = null, IReadOnlyDictionary<string, string>? metadata = null, OutboxDispatchPolicyDescriptor? dispatchPolicy = null)Parameters
Section titled “Parameters”id string
The stable outbox identifier.
displayName string
The operator-facing outbox name.
description string
The human-readable outbox description.
sourceModuleId string
The module identifier that owns the outbox surface.
provider string
The logical provider identifier that backs the outbox.
mode string
The outbox mode such as transactional-table or append-only-log.
channelIds IReadOnlyList<string>?
Optional channel identifiers that this outbox is explicitly scoped to.
tags IReadOnlyList<string>?
Optional descriptive tags associated with the outbox.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata associated with the outbox.
dispatchPolicy OutboxDispatchPolicyDescriptor?
The optional effective dispatch-execution policy. When omitted, Cephalon defaults the outbox to a disabled dispatch policy.
Properties
Section titled “Properties”ChannelIds
Section titled “ ChannelIds”Gets the optional channel identifiers that this outbox is explicitly scoped to.
public IReadOnlyList<string> ChannelIds { get; }Property Value
Section titled “Property Value”Description
Section titled “ Description”Gets the human-readable outbox description.
public string Description { get; }Property Value
Section titled “Property Value”DispatchPolicy
Section titled “ DispatchPolicy”Gets the effective dispatch-execution policy for the outbox.
public OutboxDispatchPolicyDescriptor DispatchPolicy { get; }Property Value
Section titled “Property Value”OutboxDispatchPolicyDescriptor
DisplayName
Section titled “ DisplayName”Gets the operator-facing outbox name.
public string DisplayName { get; }Property Value
Section titled “Property Value”Gets the stable outbox identifier.
public string Id { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets operator-facing metadata associated with the outbox.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Gets the outbox mode.
public string Mode { get; }Property Value
Section titled “Property Value”Provider
Section titled “ Provider”Gets the logical provider identifier that backs the outbox.
public string Provider { get; }Property Value
Section titled “Property Value”SourceModuleId
Section titled “ SourceModuleId”Gets the identifier of the module that owns the outbox surface.
public string SourceModuleId { get; }Property Value
Section titled “Property Value”Gets descriptive tags associated with the outbox.
public IReadOnlyList<string> Tags { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”WithDispatchPolicy(OutboxDispatchPolicyDescriptor)
Section titled “ WithDispatchPolicy(OutboxDispatchPolicyDescriptor)”Creates a copy of the outbox descriptor with a different dispatch policy.
public OutboxDescriptor WithDispatchPolicy(OutboxDispatchPolicyDescriptor dispatchPolicy)Parameters
Section titled “Parameters”dispatchPolicy OutboxDispatchPolicyDescriptor
The effective dispatch policy to apply.
Returns
Section titled “Returns”A new outbox descriptor with the requested dispatch policy.