Class CreateExperimentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateExperimentRequest.Builder,
CreateExperimentRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
An optional description of the experiment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MetricGoals property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Treatments property.final List
<MetricGoalConfig> 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.final String
name()
A name for the new experiment.final OnlineAbConfig
A structure that contains the configuration of which variation to use as the "control" version.final String
project()
The name or ARN of the project that you want to create the new experiment in.final String
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.final Long
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.final String
segment()
Specifies an audience segment to use in the experiment.static Class
<? extends CreateExperimentRequest.Builder> tags()
Assigns one or more tags (key-value pairs) to the experiment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<TreatmentConfig> An array of structures that describe the configuration of each feature variation used in the experiment.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
description
An optional description of the experiment.
- Returns:
- An optional description of the experiment.
-
hasMetricGoals
public final boolean hasMetricGoals()For responses, this returns true if the service returned a value for the MetricGoals property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- 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.
-
name
A name for the new experiment.
- Returns:
- A name for the new experiment.
-
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.
- Returns:
- 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.
-
project
The name or ARN of the project that you want to create the new experiment in.
- Returns:
- The name or ARN of the project that you want to create the new experiment in.
-
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 omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
.- Returns:
- 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 omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
.
-
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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- 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.
-
hasTreatments
public final boolean hasTreatments()For responses, this returns true if the service returned a value for the Treatments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- An array of structures that describe the configuration of each feature variation used in the experiment.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateExperimentRequest.Builder,
CreateExperimentRequest> - Specified by:
toBuilder
in classEvidentlyRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-