Package com.azure.analytics.onlineexperimentation.models

Class DesiredDirection

java.lang.Object

com.azure.core.util.ExpandableStringEnum<DesiredDirection>

com.azure.analytics.onlineexperimentation.models.DesiredDirection

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class DesiredDirection
extends com.azure.core.util.ExpandableStringEnum<DesiredDirection>

Desired direction for an experiment metric value.

Field Summary

Fields

Modifier and Type	Field	Description
static final DesiredDirection	DECREASE	A decrease to the metric value is desired.
static final DesiredDirection	INCREASE	An increase to the metric value is desired.
static final DesiredDirection	NEUTRAL	Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors.

Constructor Summary

Constructors

Constructor	Description
DesiredDirection()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static DesiredDirection	fromString(String name)	Creates or finds a DesiredDirection from its string representation.
static Collection<DesiredDirection>	values()	Gets known DesiredDirection values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INCREASE

public static final DesiredDirection INCREASE

An increase to the metric value is desired. E.g., Success rate, Total revenue.

DECREASE

public static final DesiredDirection DECREASE

A decrease to the metric value is desired. E.g., Error rate, Latency.

NEUTRAL

public static final DesiredDirection NEUTRAL

Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks.

Constructor Details

DesiredDirection

@Deprecated
public DesiredDirection()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of DesiredDirection value.

Method Details

fromString

public static DesiredDirection fromString(String name)

Creates or finds a DesiredDirection from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding DesiredDirection.

values

public static Collection<DesiredDirection> values()

Gets known DesiredDirection values.

Returns:

known DesiredDirection values.