software.amazon.awscdk.services.evidently

Class CfnExperiment.MetricGoalObjectProperty.Builder

java.lang.Object

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

Enclosing interface:

CfnExperiment.MetricGoalObjectProperty

public static final class CfnExperiment.MetricGoalObjectProperty.Builder
extends java.lang.Object

A builder for CfnExperiment.MetricGoalObjectProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnExperiment.MetricGoalObjectProperty	build() Builds the configured instance.
CfnExperiment.MetricGoalObjectProperty.Builder	desiredChange(java.lang.String desiredChange) Sets the value of CfnExperiment.MetricGoalObjectProperty.getDesiredChange()
CfnExperiment.MetricGoalObjectProperty.Builder	entityIdKey(java.lang.String entityIdKey) Sets the value of CfnExperiment.MetricGoalObjectProperty.getEntityIdKey()
CfnExperiment.MetricGoalObjectProperty.Builder	eventPattern(java.lang.String eventPattern) Sets the value of CfnExperiment.MetricGoalObjectProperty.getEventPattern()
CfnExperiment.MetricGoalObjectProperty.Builder	metricName(java.lang.String metricName) Sets the value of CfnExperiment.MetricGoalObjectProperty.getMetricName()
CfnExperiment.MetricGoalObjectProperty.Builder	unitLabel(java.lang.String unitLabel) Sets the value of CfnExperiment.MetricGoalObjectProperty.getUnitLabel()
CfnExperiment.MetricGoalObjectProperty.Builder	valueKey(java.lang.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 Detail

Builder

public Builder()

Method Detail

desiredChange

public CfnExperiment.MetricGoalObjectProperty.Builder desiredChange(java.lang.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

public CfnExperiment.MetricGoalObjectProperty.Builder entityIdKey(java.lang.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

public CfnExperiment.MetricGoalObjectProperty.Builder metricName(java.lang.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

public CfnExperiment.MetricGoalObjectProperty.Builder valueKey(java.lang.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

public CfnExperiment.MetricGoalObjectProperty.Builder eventPattern(java.lang.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

public CfnExperiment.MetricGoalObjectProperty.Builder unitLabel(java.lang.String unitLabel)

Sets the value of CfnExperiment.MetricGoalObjectProperty.getUnitLabel()

Parameters:

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

Returns:

this

build

public CfnExperiment.MetricGoalObjectProperty build()

Builds the configured instance.

Returns:

a new instance of CfnExperiment.MetricGoalObjectProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided