@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Experiment extends Object implements Serializable, Cloneable, StructuredPojo
A structure containing the configuration details of an experiment.
Constructor and Description |
---|
Experiment() |
Modifier and Type | Method and Description |
---|---|
Experiment |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
Experiment |
clearTagsEntries()
Removes all the entries added into Tags.
|
Experiment |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The ARN of the experiment.
|
Date |
getCreatedTime()
The date and time that the experiment is first created.
|
String |
getDescription()
A description of the experiment.
|
ExperimentExecution |
getExecution()
A structure that contains the date and time that the experiment started and ended.
|
Date |
getLastUpdatedTime()
The date and time that the experiment was most recently updated.
|
List<MetricGoal> |
getMetricGoals()
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 |
getName()
The name of the experiment.
|
OnlineAbDefinition |
getOnlineAbDefinition()
A structure that contains the configuration of which variation to use as the "control" version.
|
String |
getProject()
The name or ARN of the project that contains this experiment.
|
String |
getRandomizationSalt()
This value is used when Evidently assigns a particular user session to the experiment.
|
Long |
getSamplingRate()
In thousandths of a percent, the amount of the available audience that is allocated to this experiment.
|
ExperimentSchedule |
getSchedule()
A structure that contains the time and date that Evidently completed the analysis of the experiment.
|
String |
getSegment()
The audience segment being used for the experiment, if a segment is being used.
|
String |
getStatus()
The current state of the experiment.
|
String |
getStatusReason()
If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to
explain why it was stopped.
|
Map<String,String> |
getTags()
The list of tag keys and values associated with this experiment.
|
List<Treatment> |
getTreatments()
An array of structures that describe the configuration of each feature variation used in the experiment.
|
String |
getType()
The type of this experiment.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
The ARN of the experiment.
|
void |
setCreatedTime(Date createdTime)
The date and time that the experiment is first created.
|
void |
setDescription(String description)
A description of the experiment.
|
void |
setExecution(ExperimentExecution execution)
A structure that contains the date and time that the experiment started and ended.
|
void |
setLastUpdatedTime(Date lastUpdatedTime)
The date and time that the experiment was most recently updated.
|
void |
setMetricGoals(Collection<MetricGoal> 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.
|
void |
setName(String name)
The name of the experiment.
|
void |
setOnlineAbDefinition(OnlineAbDefinition onlineAbDefinition)
A structure that contains the configuration of which variation to use as the "control" version.
|
void |
setProject(String project)
The name or ARN of the project that contains this experiment.
|
void |
setRandomizationSalt(String randomizationSalt)
This value is used when Evidently assigns a particular user session to the experiment.
|
void |
setSamplingRate(Long samplingRate)
In thousandths of a percent, the amount of the available audience that is allocated to this experiment.
|
void |
setSchedule(ExperimentSchedule schedule)
A structure that contains the time and date that Evidently completed the analysis of the experiment.
|
void |
setSegment(String segment)
The audience segment being used for the experiment, if a segment is being used.
|
void |
setStatus(String status)
The current state of the experiment.
|
void |
setStatusReason(String statusReason)
If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to
explain why it was stopped.
|
void |
setTags(Map<String,String> tags)
The list of tag keys and values associated with this experiment.
|
void |
setTreatments(Collection<Treatment> treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
|
void |
setType(String type)
The type of this experiment.
|
String |
toString()
Returns a string representation of this object.
|
Experiment |
withArn(String arn)
The ARN of the experiment.
|
Experiment |
withCreatedTime(Date createdTime)
The date and time that the experiment is first created.
|
Experiment |
withDescription(String description)
A description of the experiment.
|
Experiment |
withExecution(ExperimentExecution execution)
A structure that contains the date and time that the experiment started and ended.
|
Experiment |
withLastUpdatedTime(Date lastUpdatedTime)
The date and time that the experiment was most recently updated.
|
Experiment |
withMetricGoals(Collection<MetricGoal> 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.
|
Experiment |
withMetricGoals(MetricGoal... 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.
|
Experiment |
withName(String name)
The name of the experiment.
|
Experiment |
withOnlineAbDefinition(OnlineAbDefinition onlineAbDefinition)
A structure that contains the configuration of which variation to use as the "control" version.
|
Experiment |
withProject(String project)
The name or ARN of the project that contains this experiment.
|
Experiment |
withRandomizationSalt(String randomizationSalt)
This value is used when Evidently assigns a particular user session to the experiment.
|
Experiment |
withSamplingRate(Long samplingRate)
In thousandths of a percent, the amount of the available audience that is allocated to this experiment.
|
Experiment |
withSchedule(ExperimentSchedule schedule)
A structure that contains the time and date that Evidently completed the analysis of the experiment.
|
Experiment |
withSegment(String segment)
The audience segment being used for the experiment, if a segment is being used.
|
Experiment |
withStatus(ExperimentStatus status)
The current state of the experiment.
|
Experiment |
withStatus(String status)
The current state of the experiment.
|
Experiment |
withStatusReason(String statusReason)
If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to
explain why it was stopped.
|
Experiment |
withTags(Map<String,String> tags)
The list of tag keys and values associated with this experiment.
|
Experiment |
withTreatments(Collection<Treatment> treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
|
Experiment |
withTreatments(Treatment... treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
|
Experiment |
withType(ExperimentType type)
The type of this experiment.
|
Experiment |
withType(String type)
The type of this experiment.
|
public void setArn(String arn)
The ARN of the experiment.
arn
- The ARN of the experiment.public String getArn()
The ARN of the experiment.
public Experiment withArn(String arn)
The ARN of the experiment.
arn
- The ARN of the experiment.public void setCreatedTime(Date createdTime)
The date and time that the experiment is first created.
createdTime
- The date and time that the experiment is first created.public Date getCreatedTime()
The date and time that the experiment is first created.
public Experiment withCreatedTime(Date createdTime)
The date and time that the experiment is first created.
createdTime
- The date and time that the experiment is first created.public void setDescription(String description)
A description of the experiment.
description
- A description of the experiment.public String getDescription()
A description of the experiment.
public Experiment withDescription(String description)
A description of the experiment.
description
- A description of the experiment.public void setExecution(ExperimentExecution execution)
A structure that contains the date and time that the experiment started and ended.
execution
- A structure that contains the date and time that the experiment started and ended.public ExperimentExecution getExecution()
A structure that contains the date and time that the experiment started and ended.
public Experiment withExecution(ExperimentExecution execution)
A structure that contains the date and time that the experiment started and ended.
execution
- A structure that contains the date and time that the experiment started and ended.public void setLastUpdatedTime(Date lastUpdatedTime)
The date and time that the experiment was most recently updated.
lastUpdatedTime
- The date and time that the experiment was most recently updated.public Date getLastUpdatedTime()
The date and time that the experiment was most recently updated.
public Experiment withLastUpdatedTime(Date lastUpdatedTime)
The date and time that the experiment was most recently updated.
lastUpdatedTime
- The date and time that the experiment was most recently updated.public List<MetricGoal> getMetricGoals()
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.
public void setMetricGoals(Collection<MetricGoal> 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.public Experiment withMetricGoals(MetricGoal... 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.
NOTE: This method appends the values to the existing list (if any). Use
setMetricGoals(java.util.Collection)
or withMetricGoals(java.util.Collection)
if you want to
override the existing values.
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.public Experiment withMetricGoals(Collection<MetricGoal> 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.public void setName(String name)
The name of the experiment.
name
- The name of the experiment.public String getName()
The name of the experiment.
public Experiment withName(String name)
The name of the experiment.
name
- The name of the experiment.public void setOnlineAbDefinition(OnlineAbDefinition onlineAbDefinition)
A structure that contains the configuration of which variation to 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.
onlineAbDefinition
- A structure that contains the configuration of which variation to 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.public OnlineAbDefinition getOnlineAbDefinition()
A structure that contains the configuration of which variation to 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.
public Experiment withOnlineAbDefinition(OnlineAbDefinition onlineAbDefinition)
A structure that contains the configuration of which variation to 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.
onlineAbDefinition
- A structure that contains the configuration of which variation to 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.public void setProject(String project)
The name or ARN of the project that contains this experiment.
project
- The name or ARN of the project that contains this experiment.public String getProject()
The name or ARN of the project that contains this experiment.
public Experiment withProject(String project)
The name or ARN of the project that contains this experiment.
project
- The name or ARN of the project that contains this experiment.public void setRandomizationSalt(String randomizationSalt)
This value is used when Evidently assigns a particular user session to the experiment. It helps create a
randomization ID to determine which variation the user session is served. This randomization ID is a combination
of the entity ID and randomizationSalt
.
randomizationSalt
- This value is used when Evidently assigns a particular user session to the experiment. It helps create a
randomization ID to determine which variation the user session is served. This randomization ID is a
combination of the entity ID and randomizationSalt
.public String getRandomizationSalt()
This value is used when Evidently assigns a particular user session to the experiment. It helps create a
randomization ID to determine which variation the user session is served. This randomization ID is a combination
of the entity ID and randomizationSalt
.
randomizationSalt
.public Experiment withRandomizationSalt(String randomizationSalt)
This value is used when Evidently assigns a particular user session to the experiment. It helps create a
randomization ID to determine which variation the user session is served. This randomization ID is a combination
of the entity ID and randomizationSalt
.
randomizationSalt
- This value is used when Evidently assigns a particular user session to the experiment. It helps create a
randomization ID to determine which variation the user session is served. This randomization ID is a
combination of the entity ID and randomizationSalt
.public void setSamplingRate(Long samplingRate)
In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.
samplingRate
- In thousandths of a percent, the amount of the available audience that is allocated to this experiment.
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, so a value of 10,000 is 10% of the available audience.
public Long getSamplingRate()
In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.
This is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.
public Experiment withSamplingRate(Long samplingRate)
In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.
samplingRate
- In thousandths of a percent, the amount of the available audience that is allocated to this experiment.
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, so a value of 10,000 is 10% of the available audience.
public void setSchedule(ExperimentSchedule schedule)
A structure that contains the time and date that Evidently completed the analysis of the experiment.
schedule
- A structure that contains the time and date that Evidently completed the analysis of the experiment.public ExperimentSchedule getSchedule()
A structure that contains the time and date that Evidently completed the analysis of the experiment.
public Experiment withSchedule(ExperimentSchedule schedule)
A structure that contains the time and date that Evidently completed the analysis of the experiment.
schedule
- A structure that contains the time and date that Evidently completed the analysis of the experiment.public void setSegment(String segment)
The audience segment being used for the experiment, if a segment is being used.
segment
- The audience segment being used for the experiment, if a segment is being used.public String getSegment()
The audience segment being used for the experiment, if a segment is being used.
public Experiment withSegment(String segment)
The audience segment being used for the experiment, if a segment is being used.
segment
- The audience segment being used for the experiment, if a segment is being used.public void setStatus(String status)
The current state of the experiment.
status
- The current state of the experiment.ExperimentStatus
public String getStatus()
The current state of the experiment.
ExperimentStatus
public Experiment withStatus(String status)
The current state of the experiment.
status
- The current state of the experiment.ExperimentStatus
public Experiment withStatus(ExperimentStatus status)
The current state of the experiment.
status
- The current state of the experiment.ExperimentStatus
public void setStatusReason(String statusReason)
If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.
statusReason
- If the experiment was stopped, this is the string that was entered by the person who stopped the
experiment, to explain why it was stopped.public String getStatusReason()
If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.
public Experiment withStatusReason(String statusReason)
If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.
statusReason
- If the experiment was stopped, this is the string that was entered by the person who stopped the
experiment, to explain why it was stopped.public Map<String,String> getTags()
The list of tag keys and values associated with this experiment.
public void setTags(Map<String,String> tags)
The list of tag keys and values associated with this experiment.
tags
- The list of tag keys and values associated with this experiment.public Experiment withTags(Map<String,String> tags)
The list of tag keys and values associated with this experiment.
tags
- The list of tag keys and values associated with this experiment.public Experiment addTagsEntry(String key, String value)
public Experiment clearTagsEntries()
public List<Treatment> getTreatments()
An array of structures that describe the configuration of each feature variation used in the experiment.
public void setTreatments(Collection<Treatment> 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.public Experiment withTreatments(Treatment... treatments)
An array of structures that describe the configuration of each feature variation used in the experiment.
NOTE: This method appends the values to the existing list (if any). Use
setTreatments(java.util.Collection)
or withTreatments(java.util.Collection)
if you want to
override the existing values.
treatments
- An array of structures that describe the configuration of each feature variation used in the experiment.public Experiment withTreatments(Collection<Treatment> 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.public void setType(String type)
The type of this experiment. Currently, this value must be aws.experiment.onlineab
.
type
- The type of this experiment. Currently, this value must be aws.experiment.onlineab
.ExperimentType
public String getType()
The type of this experiment. Currently, this value must be aws.experiment.onlineab
.
aws.experiment.onlineab
.ExperimentType
public Experiment withType(String type)
The type of this experiment. Currently, this value must be aws.experiment.onlineab
.
type
- The type of this experiment. Currently, this value must be aws.experiment.onlineab
.ExperimentType
public Experiment withType(ExperimentType type)
The type of this experiment. Currently, this value must be aws.experiment.onlineab
.
type
- The type of this experiment. Currently, this value must be aws.experiment.onlineab
.ExperimentType
public String toString()
toString
in class Object
Object.toString()
public Experiment clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.