Class ProjectionDescriptor
Namespace: Cephalon.Abstractions.Data
Assembly: Cephalon.Abstractions.dll
Describes one projection surface contributed to the active runtime.
public sealed class ProjectionDescriptorInheritance
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”ProjectionDescriptor(string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)
Section titled “ ProjectionDescriptor(string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)”Creates a new projection descriptor.
public ProjectionDescriptor(string id, string displayName, string description, string sourceModuleId, string targetStoreId, string mode = "asynchronous", IReadOnlyList<string>? sourceContracts = null, IReadOnlyList<string>? tags = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable projection identifier.
displayName string
The operator-facing projection name.
description string
The human-readable projection description.
sourceModuleId string
The module identifier that owns the projection.
targetStoreId string
The logical target store or read-model identifier populated by the projection.
mode string
The projection mode such as synchronous, asynchronous, or rebuild.
sourceContracts IReadOnlyList<string>?
Optional source contracts that can feed the projection.
tags IReadOnlyList<string>?
Optional descriptive tags associated with the projection.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata associated with the projection.
Properties
Section titled “Properties”Description
Section titled “ Description”Gets the human-readable projection description.
public string Description { get; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”Gets the operator-facing projection name.
public string DisplayName { get; }Property Value
Section titled “Property Value”Gets the stable projection identifier.
public string Id { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets operator-facing metadata associated with the projection.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Gets the projection mode.
public string Mode { get; }Property Value
Section titled “Property Value”SourceContracts
Section titled “ SourceContracts”Gets the optional source contracts that can feed the projection.
public IReadOnlyList<string> SourceContracts { get; }Property Value
Section titled “Property Value”SourceModuleId
Section titled “ SourceModuleId”Gets the identifier of the module that owns the projection.
public string SourceModuleId { get; }Property Value
Section titled “Property Value”Gets descriptive tags associated with the projection.
public IReadOnlyList<string> Tags { get; }Property Value
Section titled “Property Value”TargetStoreId
Section titled “ TargetStoreId”Gets the logical target store or read-model identifier populated by the projection.
public string TargetStoreId { get; }