ExperimentMetric Class

Definition

Namespace:: Azure.Analytics.OnlineExperimentation

Assembly:: Azure.Analytics.OnlineExperimentation.dll

Package:: Azure.Analytics.OnlineExperimentation v1.0.0-beta.1

Source:: ExperimentMetric.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines experiment metric metadata and computation details.

public class ExperimentMetric : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.OnlineExperimentation.ExperimentMetric>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.OnlineExperimentation.ExperimentMetric>

type ExperimentMetric = class
    interface IJsonModel<ExperimentMetric>
    interface IPersistableModel<ExperimentMetric>

Public Class ExperimentMetric
Implements IJsonModel(Of ExperimentMetric), IPersistableModel(Of ExperimentMetric)

Inheritance: Object
ExperimentMetric

Derived: Azure.Analytics.OnlineExperimentation.ExperimentMetricUpdate

Implements: IJsonModel<ExperimentMetric> IPersistableModel<ExperimentMetric> IPersistableModel<T>

Constructors

ExperimentMetric(LifecycleStage, String, String, IEnumerable<String>, DesiredDirection, ExperimentMetricDefinition)

Initializes a new instance of ExperimentMetric.

Properties

Categories	Categories associated with the experiment metric. Used for organizing and filtering metrics.
Definition	The metric definition specifying how the metric value is calculated from event data. Please note ExperimentMetricDefinition is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AverageMetricDefinition, EventCountMetricDefinition, EventRateMetricDefinition, PercentileMetricDefinition, SumMetricDefinition, UserCountMetricDefinition and UserRateMetricDefinition.
Description	A detailed description of the experiment metric.
DesiredDirection	The desired direction for changes in the metric value.
DisplayName	A user-friendly display name for the experiment metric shown in reports and dashboards.
ETag	ETag of the experiment metric.
Id	Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
LastModifiedAt	The timestamp (UTC) of the last modification to the experiment metric resource.
Lifecycle	Determines whether it is included in experiment analysis.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ExperimentMetric>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ExperimentMetric>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ExperimentMetric>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ExperimentMetric>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ExperimentMetric>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via