Class MetricSetMetadata

Metadata (e.g. name, version) connected to a metric set.

Inheritance

Object

MetricSetMetadata

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Mangrove.MetricSetSyntaxTree

Assembly: MetricSetSyntaxTree.dll

Syntax

public class MetricSetMetadata

Constructors

MetricSetMetadata(String, String, String, IReadOnlyCollection<String>)

Construct a metadata object from simpler objects.

Declaration

public MetricSetMetadata(string name, string version, string profiles, IReadOnlyCollection<string> owners)

Parameters

Type	Name	Description
String	name	Name of the underlying metric set (e.g. SLAPI).
String	version	Changelist of the underlying metric set (e.g. 636721842093509779 for SLAPI).
String	profiles	Serialized profile (computation or layout) object.
IReadOnlyCollection<String>	owners	All owners of the metric set.

Fields

NGPTagsKey

Store NGP tags result in RuntimeProperties by this key.

Declaration

public const string NGPTagsKey = "NGPTags"

Field Value

Type	Description
String

Properties

Name

The name of the metric set underlying this metadata.

Declaration

public string Name { get; }

Property Value

Type	Description
String

Owners

All owners of the metric set.

Declaration

public IReadOnlyList<string> Owners { get; }

Property Value

Type	Description
IReadOnlyList<String>

Profiles

Serialized profile for all computation, analysis, and analysis profiles in the metric set. You must use the Coordinator.Configuration.Contract library to convert these to a MetricSetConfiguration object.

Declaration

public string Profiles { get; }

Property Value

Type	Description
String

Remarks

Why not include ComputationConfig objects? The MetricsPlan should not know about their internals. Otherwise, it would be too easy to start using them when writing transformer objects, and this would make it very difficult to decouple configs and MetricsPlan down the road. This design (carry only the string payload) makes it easy to separate MDL (metric definitions) and computation / layout config storage later on.

RuntimeProperties

To store the runtime properties.

Declaration

public Dictionary<string, object> RuntimeProperties { get; }

Property Value

Type	Description
Dictionary<String, Object>

Version

The version of this copy of the metric set.

Declaration

public string Version { get; }

Property Value

Type	Description
String

Extension Methods

ObjectExtensions.EventId(Object)