AnalyticsOnlineExperimentationModelFactory.ExperimentMetric Method

Definition

Namespace:

Azure.Analytics.OnlineExperimentation

Assembly:

Azure.Analytics.OnlineExperimentation.dll

Package:

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

Source:

AnalyticsOnlineExperimentationModelFactory.cs

Initializes a new instance of ExperimentMetric.

public static Azure.Analytics.OnlineExperimentation.ExperimentMetric ExperimentMetric(string id = default, Azure.Analytics.OnlineExperimentation.LifecycleStage lifecycle = default, string displayName = default, string description = default, System.Collections.Generic.IEnumerable<string> categories = default, Azure.Analytics.OnlineExperimentation.DesiredDirection desiredDirection = default, Azure.Analytics.OnlineExperimentation.ExperimentMetricDefinition definition = default, Azure.ETag eTag = default, DateTimeOffset lastModifiedAt = default);

static member ExperimentMetric : string * Azure.Analytics.OnlineExperimentation.LifecycleStage * string * string * seq<string> * Azure.Analytics.OnlineExperimentation.DesiredDirection * Azure.Analytics.OnlineExperimentation.ExperimentMetricDefinition * Azure.ETag * DateTimeOffset -> Azure.Analytics.OnlineExperimentation.ExperimentMetric

Public Shared Function ExperimentMetric (Optional id As String = Nothing, Optional lifecycle As LifecycleStage = Nothing, Optional displayName As String = Nothing, Optional description As String = Nothing, Optional categories As IEnumerable(Of String) = Nothing, Optional desiredDirection As DesiredDirection = Nothing, Optional definition As ExperimentMetricDefinition = Nothing, Optional eTag As ETag = Nothing, Optional lastModifiedAt As DateTimeOffset = Nothing) As ExperimentMetric

Parameters

id

String

Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.

lifecycle

LifecycleStage

Determines whether it is included in experiment analysis.

displayName

String

A user-friendly display name for the experiment metric shown in reports and dashboards.

description

String

A detailed description of the experiment metric.

categories

IEnumerable<String>

Categories associated with the experiment metric. Used for organizing and filtering metrics.

desiredDirection

DesiredDirection

The desired direction for changes in the metric value.

definition

ExperimentMetricDefinition

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.

eTag

ETag

ETag of the experiment metric.

lastModifiedAt

DateTimeOffset

The timestamp (UTC) of the last modification to the experiment metric resource.

Returns

ExperimentMetric

A new ExperimentMetric instance for mocking.