Package software.amazon.awscdk.services.evidently

Class CfnExperiment.MetricGoalObjectProperty.Builder

java.lang.Object

software.amazon.awscdk.services.evidently.CfnExperiment.MetricGoalObjectProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnExperiment.MetricGoalObjectProperty>

Enclosing interface:

CfnExperiment.MetricGoalObjectProperty

@Stability(Stable)
public static final class CfnExperiment.MetricGoalObjectProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnExperiment.MetricGoalObjectProperty>

A builder for CfnExperiment.MetricGoalObjectProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnExperiment.MetricGoalObjectProperty	build()	Builds the configured instance.
CfnExperiment.MetricGoalObjectProperty.Builder	desiredChange(String desiredChange)	Sets the value of CfnExperiment.MetricGoalObjectProperty.getDesiredChange()
CfnExperiment.MetricGoalObjectProperty.Builder	entityIdKey(String entityIdKey)	Sets the value of CfnExperiment.MetricGoalObjectProperty.getEntityIdKey()
CfnExperiment.MetricGoalObjectProperty.Builder	eventPattern(String eventPattern)	Sets the value of CfnExperiment.MetricGoalObjectProperty.getEventPattern()
CfnExperiment.MetricGoalObjectProperty.Builder	metricName(String metricName)	Sets the value of CfnExperiment.MetricGoalObjectProperty.getMetricName()
CfnExperiment.MetricGoalObjectProperty.Builder	unitLabel(String unitLabel)	Sets the value of CfnExperiment.MetricGoalObjectProperty.getUnitLabel()
CfnExperiment.MetricGoalObjectProperty.Builder	valueKey(String valueKey)	Sets the value of CfnExperiment.MetricGoalObjectProperty.getValueKey()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

desiredChange

@Stability(Stable)
public CfnExperiment.MetricGoalObjectProperty.Builder desiredChange(String desiredChange)

Sets the value of CfnExperiment.MetricGoalObjectProperty.getDesiredChange()

Parameters:

desiredChange - INCREASE means that a variation with a higher number for this metric is performing better. This parameter is required. DECREASE means that a variation with a lower number for this metric is performing better.

Returns:

this

entityIdKey

@Stability(Stable)
public CfnExperiment.MetricGoalObjectProperty.Builder entityIdKey(String entityIdKey)

Sets the value of CfnExperiment.MetricGoalObjectProperty.getEntityIdKey()

Parameters:

entityIdKey - The entity, such as a user or session, that does an action that causes a metric value to be recorded. This parameter is required. An example is userDetails.userID .

Returns:

this

metricName

@Stability(Stable)
public CfnExperiment.MetricGoalObjectProperty.Builder metricName(String metricName)

Sets the value of CfnExperiment.MetricGoalObjectProperty.getMetricName()

Parameters:

metricName - A name for the metric. This parameter is required. It can include up to 255 characters.

Returns:

this

valueKey

@Stability(Stable)
public CfnExperiment.MetricGoalObjectProperty.Builder valueKey(String valueKey)

Sets the value of CfnExperiment.MetricGoalObjectProperty.getValueKey()

Parameters:

valueKey - The JSON path to reference the numerical metric value in the event. This parameter is required.

Returns:

this

eventPattern

@Stability(Stable)
public CfnExperiment.MetricGoalObjectProperty.Builder eventPattern(String eventPattern)

Sets the value of CfnExperiment.MetricGoalObjectProperty.getEventPattern()

Parameters:

eventPattern - The EventBridge event pattern that defines how the metric is recorded. For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

Returns:

this

unitLabel

@Stability(Stable)
public CfnExperiment.MetricGoalObjectProperty.Builder unitLabel(String unitLabel)

Sets the value of CfnExperiment.MetricGoalObjectProperty.getUnitLabel()

Parameters:

unitLabel - A label for the units that the metric is measuring.

Returns:

this

build

@Stability(Stable)
public CfnExperiment.MetricGoalObjectProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnExperiment.MetricGoalObjectProperty>

Returns:

a new instance of CfnExperiment.MetricGoalObjectProperty

Throws:

NullPointerException - if any required attribute was not provided