Class CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.evidently.CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnExperimentPropsMixin.MetricGoalObjectProperty>
- Enclosing interface:
CfnExperimentPropsMixin.MetricGoalObjectProperty
@Stability(Stable)
public static final class CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnExperimentPropsMixin.MetricGoalObjectProperty>
A builder for
CfnExperimentPropsMixin.MetricGoalObjectProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.desiredChange(String desiredChange) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getDesiredChange()entityIdKey(String entityIdKey) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getEntityIdKey()eventPattern(String eventPattern) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getEventPattern()metricName(String metricName) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getMetricName()Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getUnitLabel()Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getValueKey()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
desiredChange
@Stability(Stable) public CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder desiredChange(String desiredChange) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getDesiredChange()- Parameters:
desiredChange-INCREASEmeans that a variation with a higher number for this metric is performing better.DECREASEmeans that a variation with a lower number for this metric is performing better.- Returns:
this
-
entityIdKey
@Stability(Stable) public CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder entityIdKey(String entityIdKey) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getEntityIdKey()- Parameters:
entityIdKey- The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example isuserDetails.userID.- Returns:
this
-
eventPattern
@Stability(Stable) public CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder eventPattern(String eventPattern) Sets the value ofCfnExperimentPropsMixin.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
-
metricName
@Stability(Stable) public CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder metricName(String metricName) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getMetricName()- Parameters:
metricName- A name for the metric. It can include up to 255 characters.- Returns:
this
-
unitLabel
@Stability(Stable) public CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder unitLabel(String unitLabel) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getUnitLabel()- Parameters:
unitLabel- A label for the units that the metric is measuring.- Returns:
this
-
valueKey
@Stability(Stable) public CfnExperimentPropsMixin.MetricGoalObjectProperty.Builder valueKey(String valueKey) Sets the value ofCfnExperimentPropsMixin.MetricGoalObjectProperty.getValueKey()- Parameters:
valueKey- The JSON path to reference the numerical metric value in the event.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnExperimentPropsMixin.MetricGoalObjectProperty>- Returns:
- a new instance of
CfnExperimentPropsMixin.MetricGoalObjectProperty - Throws:
NullPointerException- if any required attribute was not provided
-