Skip to content

Class HostedExecutionDescriptor

Namespace: Cephalon.Abstractions.Execution
Assembly: Cephalon.Abstractions.dll

Describes one operator-facing hosted or background execution surface contributed by an active module.

public sealed class HostedExecutionDescriptor

objectHostedExecutionDescriptor

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

HostedExecutionDescriptor(string, string, string, string, string, string?, bool, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)

Section titled “ HostedExecutionDescriptor(string, string, string, string, string, string?, bool, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)”

Creates a new hosted execution descriptor.

[JsonConstructor]
public HostedExecutionDescriptor(string id, string displayName, string description, string sourceModuleId, string kind, string? executionGraphId = null, bool startsWithHost = true, IReadOnlyList<string>? tags = null, IReadOnlyDictionary<string, string>? metadata = null)

id string

The stable hosted-execution identifier.

displayName string

The operator-facing hosted-execution name.

description string

A human-readable description of the hosted execution.

sourceModuleId string

The module identifier that owns the hosted execution.

kind string

The operator-facing hosted-execution kind such as background-service, timer, or listener.

executionGraphId string?

The related execution-graph identifier when this hosted execution drives one graph directly.

startsWithHost bool

A value indicating whether the hosted execution is expected to become active when the runtime host starts.

tags IReadOnlyList<string>?

Optional descriptive tags associated with the hosted execution.

metadata IReadOnlyDictionary<string, string>?

Optional operator-facing metadata associated with the hosted execution.

Gets the human-readable description of the hosted execution.

public string Description { get; }

string

Gets the operator-facing hosted-execution name.

public string DisplayName { get; }

string

Gets the related execution-graph identifier when one is declared.

public string? ExecutionGraphId { get; }

string?

Gets the stable hosted-execution identifier.

public string Id { get; }

string

Gets the operator-facing hosted-execution kind.

public string Kind { get; }

string

Gets operator-facing metadata associated with the hosted execution.

public IReadOnlyDictionary<string, string> Metadata { get; }

IReadOnlyDictionary<string, string>

Gets the identifier of the module that contributed the hosted execution.

public string SourceModuleId { get; }

string

Gets a value indicating whether the hosted execution is expected to become active when the runtime host starts.

public bool StartsWithHost { get; }

bool

Gets descriptive tags associated with the hosted execution.

public IReadOnlyList<string> Tags { get; }

IReadOnlyList<string>