Package software.amazon.awscdk.services.evidently

Interface CfnExperiment.MetricGoalObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExperiment.MetricGoalObjectProperty.Jsii$Proxy

Enclosing class:

CfnExperiment

@Stability(Stable)
public static interface CfnExperiment.MetricGoalObjectProperty
extends software.amazon.jsii.JsiiSerializable

Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.evidently.*;
 MetricGoalObjectProperty metricGoalObjectProperty = MetricGoalObjectProperty.builder()
         .desiredChange("desiredChange")
         .entityIdKey("entityIdKey")
         .metricName("metricName")
         .valueKey("valueKey")
         // the properties below are optional
         .eventPattern("eventPattern")
         .unitLabel("unitLabel")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnExperiment.MetricGoalObjectProperty.Builder	A builder for CfnExperiment.MetricGoalObjectProperty
static final class	CfnExperiment.MetricGoalObjectProperty.Jsii$Proxy	An implementation for CfnExperiment.MetricGoalObjectProperty

Method Summary

Modifier and Type	Method	Description
static CfnExperiment.MetricGoalObjectProperty.Builder	builder()
String	getDesiredChange()	INCREASE means that a variation with a higher number for this metric is performing better.
String	getEntityIdKey()	The entity, such as a user or session, that does an action that causes a metric value to be recorded.
default String	getEventPattern()	The EventBridge event pattern that defines how the metric is recorded.
String	getMetricName()	A name for the metric.
default String	getUnitLabel()	A label for the units that the metric is measuring.
String	getValueKey()	The JSON path to reference the numerical metric value in the event.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDesiredChange

@Stability(Stable)
@NotNull
String getDesiredChange()

INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-desiredchange

getEntityIdKey

@Stability(Stable)
@NotNull
String getEntityIdKey()

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

An example is userDetails.userID .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-entityidkey

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

A name for the metric.

It can include up to 255 characters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-metricname

getValueKey

@Stability(Stable)
@NotNull
String getValueKey()

The JSON path to reference the numerical metric value in the event.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-valuekey

getEventPattern

@Stability(Stable)
@Nullable
default String getEventPattern()

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-eventpattern

getUnitLabel

@Stability(Stable)
@Nullable
default String getUnitLabel()

A label for the units that the metric is measuring.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-unitlabel

builder

@Stability(Stable)
static CfnExperiment.MetricGoalObjectProperty.Builder builder()

Returns:

a CfnExperiment.MetricGoalObjectProperty.Builder of CfnExperiment.MetricGoalObjectProperty