com.amazonaws.services.cloudwatchevidently.model

Class UpdateExperimentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatchevidently.model.UpdateExperimentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateExperimentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateExperimentRequest()

Method Summary

Modifier and Type	Method and Description
UpdateExperimentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() An optional description of the experiment.
String	getExperiment() The name of the experiment to update.
List<MetricGoalConfig>	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.
OnlineAbConfig	getOnlineAbConfig() A structure that contains the configuration of which variation o use as the "control" version.
String	getProject() The name or ARN of the project that contains the experiment that you want to update.
String	getRandomizationSalt() 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.
Boolean	getRemoveSegment() Removes a segment from being used in an experiment.
Long	getSamplingRate() The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
String	getSegment() Adds an audience segment to an experiment.
List<TreatmentConfig>	getTreatments() An array of structures that define the variations being tested in the experiment.
int	hashCode()
Boolean	isRemoveSegment() Removes a segment from being used in an experiment.
void	setDescription(String description) An optional description of the experiment.
void	setExperiment(String experiment) The name of the experiment to update.
void	setMetricGoals(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.
void	setOnlineAbConfig(OnlineAbConfig onlineAbConfig) A structure that contains the configuration of which variation o use as the "control" version.
void	setProject(String project) The name or ARN of the project that contains the experiment that you want to update.
void	setRandomizationSalt(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.
void	setRemoveSegment(Boolean removeSegment) Removes a segment from being used in an experiment.
void	setSamplingRate(Long samplingRate) The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
void	setSegment(String segment) Adds an audience segment to an experiment.
void	setTreatments(Collection<TreatmentConfig> treatments) An array of structures that define the variations being tested in the experiment.
String	toString() Returns a string representation of this object.
UpdateExperimentRequest	withDescription(String description) An optional description of the experiment.
UpdateExperimentRequest	withExperiment(String experiment) The name of the experiment to update.
UpdateExperimentRequest	withMetricGoals(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	withMetricGoals(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	withOnlineAbConfig(OnlineAbConfig onlineAbConfig) A structure that contains the configuration of which variation o use as the "control" version.
UpdateExperimentRequest	withProject(String project) The name or ARN of the project that contains the experiment that you want to update.
UpdateExperimentRequest	withRandomizationSalt(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	withRemoveSegment(Boolean removeSegment) Removes a segment from being used in an experiment.
UpdateExperimentRequest	withSamplingRate(Long samplingRate) The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
UpdateExperimentRequest	withSegment(String segment) Adds an audience segment to an experiment.
UpdateExperimentRequest	withTreatments(Collection<TreatmentConfig> treatments) An array of structures that define the variations being tested in the experiment.
UpdateExperimentRequest	withTreatments(TreatmentConfig... treatments) An array of structures that define the variations being tested in the experiment.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateExperimentRequest

public UpdateExperimentRequest()

Method Detail

setDescription

public void setDescription(String description)

An optional description of the experiment.

Parameters:

description - An optional description of the experiment.

getDescription

public String getDescription()

An optional description of the experiment.

Returns:

An optional description of the experiment.

withDescription

public UpdateExperimentRequest withDescription(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.

setExperiment

public void setExperiment(String experiment)

The name of the experiment to update.

Parameters:

experiment - The name of the experiment to update.

getExperiment

public String getExperiment()

The name of the experiment to update.

Returns:

The name of the experiment to update.

withExperiment

public UpdateExperimentRequest withExperiment(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.

getMetricGoals

public List<MetricGoalConfig> 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.

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.

setMetricGoals

public void setMetricGoals(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.

withMetricGoals

public UpdateExperimentRequest withMetricGoals(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.

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.

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.

withMetricGoals

public UpdateExperimentRequest withMetricGoals(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.

setOnlineAbConfig

public void setOnlineAbConfig(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.

getOnlineAbConfig

public OnlineAbConfig getOnlineAbConfig()

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:

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.

withOnlineAbConfig

public UpdateExperimentRequest withOnlineAbConfig(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.

setProject

public void setProject(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.

getProject

public String getProject()

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

Returns:

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

withProject

public UpdateExperimentRequest withProject(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.

setRandomizationSalt

public void setRandomizationSalt(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.

getRandomizationSalt

public String getRandomizationSalt()

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:

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.

withRandomizationSalt

public UpdateExperimentRequest withRandomizationSalt(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.

setRemoveSegment

public void setRemoveSegment(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.

getRemoveSegment

public Boolean getRemoveSegment()

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

Returns:

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

withRemoveSegment

public UpdateExperimentRequest withRemoveSegment(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.

isRemoveSegment

public Boolean isRemoveSegment()

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

Returns:

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

setSamplingRate

public void setSamplingRate(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.

getSamplingRate

public Long getSamplingRate()

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:

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.

withSamplingRate

public UpdateExperimentRequest withSamplingRate(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.

setSegment

public void setSegment(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.

getSegment

public String getSegment()

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:

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.

withSegment

public UpdateExperimentRequest withSegment(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.

getTreatments

public List<TreatmentConfig> getTreatments()

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

Returns:

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

setTreatments

public void setTreatments(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.

withTreatments

public UpdateExperimentRequest withTreatments(TreatmentConfig... treatments)

An array of structures that define the variations being tested 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.

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.

withTreatments

public UpdateExperimentRequest withTreatments(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.

toString

public String 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateExperimentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()