@Generated(value="software.amazon.awssdk:codegen") public final class CreateExperimentRequest extends EvidentlyRequest implements ToCopyableBuilder<CreateExperimentRequest.Builder,CreateExperimentRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateExperimentRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateExperimentRequest.Builder |
builder() |
String |
description()
An optional description of the experiment.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasMetricGoals()
For responses, this returns true if the service returned a value for the MetricGoals property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasTreatments()
For responses, this returns true if the service returned a value for the Treatments property.
|
List<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.
|
String |
name()
A name for the new experiment.
|
OnlineAbConfig |
onlineAbConfig()
A structure that contains the configuration of which variation to use as the "control" version.
|
String |
project()
The name or ARN of the project that you want to create the new experiment in.
|
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.
|
Long |
samplingRate()
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
|
List<SdkField<?>> |
sdkFields() |
String |
segment()
Specifies an audience segment to use in the experiment.
|
static Class<? extends CreateExperimentRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
Assigns one or more tags (key-value pairs) to the experiment.
|
CreateExperimentRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<TreatmentConfig> |
treatments()
An array of structures that describe the configuration of each feature variation used in the experiment.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String description()
An optional description of the experiment.
public final boolean hasMetricGoals()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasMetricGoals() method.
public final String name()
A name for the new experiment.
public final 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.
public final String project()
The name or ARN of the project that you want to create the new experiment in.
public final 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. If you omit randomizationSalt, Evidently uses
the experiment name as the randomizationSalt.public final 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.
This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.
public final 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.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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.
public final boolean hasTreatments()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<TreatmentConfig> treatments()
An array of structures that describe the configuration of each feature variation used in the experiment.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTreatments() method.
public CreateExperimentRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateExperimentRequest.Builder,CreateExperimentRequest>toBuilder in class EvidentlyRequestpublic static CreateExperimentRequest.Builder builder()
public static Class<? extends CreateExperimentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.