software.amazon.awssdk.services.evidently.model

Interface UpdateExperimentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>, EvidentlyRequest.Builder, SdkBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateExperimentRequest

public static interface UpdateExperimentRequest.Builder
extends EvidentlyRequest.Builder, SdkPojo, CopyableBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>

Method Summary

Modifier and Type	Method and Description
UpdateExperimentRequest.Builder	description(String description) An optional description of the experiment.
UpdateExperimentRequest.Builder	experiment(String experiment) The name of the experiment to update.
UpdateExperimentRequest.Builder	metricGoals(Collection<MetricGoalConfig> metricGoals) An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
UpdateExperimentRequest.Builder	metricGoals(Consumer<MetricGoalConfig.Builder>... metricGoals) An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
UpdateExperimentRequest.Builder	metricGoals(MetricGoalConfig... metricGoals) An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
default UpdateExperimentRequest.Builder	onlineAbConfig(Consumer<OnlineAbConfig.Builder> onlineAbConfig) A structure that contains the configuration of which variation o use as the "control" version.
UpdateExperimentRequest.Builder	onlineAbConfig(OnlineAbConfig onlineAbConfig) A structure that contains the configuration of which variation o use as the "control" version.
UpdateExperimentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateExperimentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateExperimentRequest.Builder	project(String project) The name or ARN of the project that contains the experiment that you want to update.
UpdateExperimentRequest.Builder	randomizationSalt(String randomizationSalt) When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served.
UpdateExperimentRequest.Builder	removeSegment(Boolean removeSegment) Removes a segment from being used in an experiment.
UpdateExperimentRequest.Builder	samplingRate(Long samplingRate) The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
UpdateExperimentRequest.Builder	segment(String segment) Adds an audience segment to an experiment.
UpdateExperimentRequest.Builder	treatments(Collection<TreatmentConfig> treatments) An array of structures that define the variations being tested in the experiment.
UpdateExperimentRequest.Builder	treatments(Consumer<TreatmentConfig.Builder>... treatments) An array of structures that define the variations being tested in the experiment.
UpdateExperimentRequest.Builder	treatments(TreatmentConfig... treatments) An array of structures that define the variations being tested in the experiment.

Methods inherited from interface software.amazon.awssdk.services.evidently.model.EvidentlyRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

description

UpdateExperimentRequest.Builder description(String description)

An optional description of the experiment.

Parameters:

description - An optional description of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

experiment

UpdateExperimentRequest.Builder experiment(String experiment)

The name of the experiment to update.

Parameters:

experiment - The name of the experiment to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricGoals

UpdateExperimentRequest.Builder metricGoals(Collection<MetricGoalConfig> metricGoals)

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

Parameters:

metricGoals - An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricGoals

UpdateExperimentRequest.Builder metricGoals(MetricGoalConfig... metricGoals)

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

Parameters:

metricGoals - An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricGoals

UpdateExperimentRequest.Builder metricGoals(Consumer<MetricGoalConfig.Builder>... metricGoals)

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

This is a convenience method that creates an instance of the MetricGoalConfig.Builder avoiding the need to create one manually via MetricGoalConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #metricGoals(List).

Parameters:

metricGoals - a consumer that will call methods on MetricGoalConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#metricGoals(java.util.Collection)

onlineAbConfig

UpdateExperimentRequest.Builder onlineAbConfig(OnlineAbConfig onlineAbConfig)

A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

Parameters:

onlineAbConfig - A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

Returns:

Returns a reference to this object so that method calls can be chained together.

onlineAbConfig

default UpdateExperimentRequest.Builder onlineAbConfig(Consumer<OnlineAbConfig.Builder> onlineAbConfig)

A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

This is a convenience method that creates an instance of the OnlineAbConfig.Builder avoiding the need to create one manually via OnlineAbConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onlineAbConfig(OnlineAbConfig).

Parameters:

onlineAbConfig - a consumer that will call methods on OnlineAbConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

onlineAbConfig(OnlineAbConfig)

project

UpdateExperimentRequest.Builder project(String project)

The name or ARN of the project that contains the experiment that you want to update.

Parameters:

project - The name or ARN of the project that contains the experiment that you want to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

randomizationSalt

UpdateExperimentRequest.Builder randomizationSalt(String randomizationSalt)

When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

Parameters:

randomizationSalt - When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

Returns:

Returns a reference to this object so that method calls can be chained together.

removeSegment

UpdateExperimentRequest.Builder removeSegment(Boolean removeSegment)

Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.

Parameters:

removeSegment - Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.

Returns:

Returns a reference to this object so that method calls can be chained together.

samplingRate

UpdateExperimentRequest.Builder samplingRate(Long samplingRate)

The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.

Parameters:

samplingRate - The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.

Returns:

Returns a reference to this object so that method calls can be chained together.

segment

UpdateExperimentRequest.Builder segment(String segment)

Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.

Parameters:

segment - Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.

Returns:

Returns a reference to this object so that method calls can be chained together.

treatments

UpdateExperimentRequest.Builder treatments(Collection<TreatmentConfig> treatments)

An array of structures that define the variations being tested in the experiment.

Parameters:

treatments - An array of structures that define the variations being tested in the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

treatments

UpdateExperimentRequest.Builder treatments(TreatmentConfig... treatments)

An array of structures that define the variations being tested in the experiment.

Parameters:

treatments - An array of structures that define the variations being tested in the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

treatments

UpdateExperimentRequest.Builder treatments(Consumer<TreatmentConfig.Builder>... treatments)

An array of structures that define the variations being tested in the experiment.

This is a convenience method that creates an instance of the TreatmentConfig.Builder avoiding the need to create one manually via TreatmentConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #treatments(List).

Parameters:

treatments - a consumer that will call methods on TreatmentConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#treatments(java.util.Collection)

overrideConfiguration

UpdateExperimentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateExperimentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder