Class KnowledgeDocumentProviderContext
Namespace: Cephalon.Retrieval.Services
Assembly: Cephalon.Retrieval.dll
Provides request context to a knowledge document provider during managed indexing.
public sealed class KnowledgeDocumentProviderContextInheritance
Section titled “Inheritance”object ← KnowledgeDocumentProviderContext
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”KnowledgeDocumentProviderContext(KnowledgeCollectionDescriptor, string, DateTimeOffset, string?, string?, IReadOnlyDictionary<string, string>?)
Section titled “ KnowledgeDocumentProviderContext(KnowledgeCollectionDescriptor, string, DateTimeOffset, string?, string?, IReadOnlyDictionary<string, string>?)”Creates provider context for a managed indexing request.
public KnowledgeDocumentProviderContext(KnowledgeCollectionDescriptor collection, string runId, DateTimeOffset requestedAtUtc, string? actorId = null, string? correlationId = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”collection KnowledgeCollectionDescriptor
The collection being indexed.
runId string
The stable indexing run identifier.
requestedAtUtc DateTimeOffset
The UTC timestamp when indexing was requested.
actorId string?
The optional actor that requested indexing.
correlationId string?
The optional correlation identifier for the indexing run.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata attached to the indexing request.
Properties
Section titled “Properties”ActorId
Section titled “ ActorId”Gets the optional actor that requested indexing.
public string? ActorId { get; }Property Value
Section titled “Property Value”Collection
Section titled “ Collection”Gets the collection being indexed.
public KnowledgeCollectionDescriptor Collection { get; }Property Value
Section titled “Property Value”CorrelationId
Section titled “ CorrelationId”Gets the optional correlation identifier for the indexing run.
public string? CorrelationId { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets optional operator-facing metadata attached to the indexing request.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
RequestedAtUtc
Section titled “ RequestedAtUtc”Gets the UTC timestamp when indexing was requested.
public DateTimeOffset RequestedAtUtc { get; }Property Value
Section titled “Property Value”Gets the stable indexing run identifier.
public string RunId { get; }