public static interface CreateExperimentRequest.Builder extends EvidentlyRequest.Builder, SdkPojo, CopyableBuilder<CreateExperimentRequest.Builder,CreateExperimentRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateExperimentRequest.Builder |
description(String description)
An optional description of the experiment.
|
CreateExperimentRequest.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.
|
CreateExperimentRequest.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.
|
CreateExperimentRequest.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.
|
CreateExperimentRequest.Builder |
name(String name)
A name for the new experiment.
|
default CreateExperimentRequest.Builder |
onlineAbConfig(Consumer<OnlineAbConfig.Builder> onlineAbConfig)
A structure that contains the configuration of which variation to use as the "control" version.
|
CreateExperimentRequest.Builder |
onlineAbConfig(OnlineAbConfig onlineAbConfig)
A structure that contains the configuration of which variation to use as the "control" version.
|
CreateExperimentRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateExperimentRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateExperimentRequest.Builder |
project(String project)
The name or ARN of the project that you want to create the new experiment in.
|
CreateExperimentRequest.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.
|
CreateExperimentRequest.Builder |
samplingRate(Long samplingRate)
The portion of the available audience that you want to allocate to this experiment, in thousandths of a
percent.
|
CreateExperimentRequest.Builder |
segment(String segment)
Specifies an audience segment to use in the experiment.
|
CreateExperimentRequest.Builder |
tags(Map<String,String> tags)
Assigns one or more tags (key-value pairs) to the experiment.
|
CreateExperimentRequest.Builder |
treatments(Collection<TreatmentConfig> treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
|
CreateExperimentRequest.Builder |
treatments(Consumer<TreatmentConfig.Builder>... treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
|
CreateExperimentRequest.Builder |
treatments(TreatmentConfig... treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateExperimentRequest.Builder description(String description)
An optional description of the experiment.
description - An optional description of the experiment.CreateExperimentRequest.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.
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.CreateExperimentRequest.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.
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.CreateExperimentRequest.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 theMetricGoalConfig.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.
metricGoals - a consumer that will call methods on
MetricGoalConfig.Builder#metricGoals(java.util.Collection) CreateExperimentRequest.Builder name(String name)
A name for the new experiment.
name - A name for the new experiment.CreateExperimentRequest.Builder onlineAbConfig(OnlineAbConfig onlineAbConfig)
A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
onlineAbConfig - A structure that contains the configuration of which variation to use as the "control" version. tThe
"control" version is used for comparison with other variations. This structure also specifies how much
experiment traffic is allocated to each variation.default CreateExperimentRequest.Builder onlineAbConfig(Consumer<OnlineAbConfig.Builder> onlineAbConfig)
A structure that contains the configuration of which variation to use as the "control" version. tThe "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 theOnlineAbConfig.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).
onlineAbConfig - a consumer that will call methods on OnlineAbConfig.BuilderonlineAbConfig(OnlineAbConfig)CreateExperimentRequest.Builder project(String project)
The name or ARN of the project that you want to create the new experiment in.
project - The name or ARN of the project that you want to create the new experiment in.CreateExperimentRequest.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.
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.CreateExperimentRequest.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 10,000 to allocate 10% of the available audience.
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 10,000 to allocate 10% of the available audience.
CreateExperimentRequest.Builder segment(String segment)
Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.
segment - Specifies an audience segment to use in the experiment. When a segment is used in an
experiment, only user sessions that match the segment pattern are used in the experiment.CreateExperimentRequest.Builder tags(Map<String,String> tags)
Assigns one or more tags (key-value pairs) to the experiment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an experiment.
For more information, see Tagging Amazon Web Services resources.
tags - Assigns one or more tags (key-value pairs) to the experiment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an experiment.
For more information, see Tagging Amazon Web Services resources.
CreateExperimentRequest.Builder treatments(Collection<TreatmentConfig> treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
treatments - An array of structures that describe the configuration of each feature variation used in the
experiment.CreateExperimentRequest.Builder treatments(TreatmentConfig... treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
treatments - An array of structures that describe the configuration of each feature variation used in the
experiment.CreateExperimentRequest.Builder treatments(Consumer<TreatmentConfig.Builder>... treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
This is a convenience method that creates an instance of theTreatmentConfig.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.
treatments - a consumer that will call methods on
TreatmentConfig.Builder#treatments(java.util.Collection) CreateExperimentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateExperimentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.