All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateExperimentRequest
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
  CreateExperimentRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  CreateExperimentRequest	addTagsEntry (String key, String value) Add a single Tags entry
  CreateExperimentRequest	clearTagsEntries () Removes all the entries added into Tags.
  CreateExperimentRequest	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.
  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.
  String	getName () A name for the new experiment.
  OnlineAbConfig	getOnlineAbConfig () 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 you want to create the new experiment in.
  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.
  Long	getSamplingRate () The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
  String	getSegment () Specifies an audience segment to use in the experiment.
  Map<String,String>	getTags () Assigns one or more tags (key-value pairs) to the experiment.
  List<TreatmentConfig>	getTreatments () An array of structures that describe the configuration of each feature variation used in the experiment.
  int	hashCode ()
  void	setDescription (String description) An optional description of the experiment.
  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	setName (String name) A name for the new experiment.
  void	setOnlineAbConfig (OnlineAbConfig onlineAbConfig) 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 you want to create the new experiment in.
  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	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) Specifies an audience segment to use in the experiment.
  void	setTags (Map<String,String> tags) Assigns one or more tags (key-value pairs) to the experiment.
  void	setTreatments (Collection<TreatmentConfig> treatments) An array of structures that describe the configuration of each feature variation used in the experiment.
  String	toString () Returns a string representation of this object.
  CreateExperimentRequest	withDescription (String description) An optional description of the experiment.
  CreateExperimentRequest	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.
  CreateExperimentRequest	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.
  CreateExperimentRequest	withName (String name) A name for the new experiment.
  CreateExperimentRequest	withOnlineAbConfig (OnlineAbConfig onlineAbConfig) A structure that contains the configuration of which variation to use as the "control" version.
  CreateExperimentRequest	withProject (String project) The name or ARN of the project that you want to create the new experiment in.
  CreateExperimentRequest	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.
  CreateExperimentRequest	withSamplingRate (Long samplingRate) The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
  CreateExperimentRequest	withSegment (String segment) Specifies an audience segment to use in the experiment.
  CreateExperimentRequest	withTags (Map<String,String> tags) Assigns one or more tags (key-value pairs) to the experiment.
  CreateExperimentRequest	withTreatments (Collection<TreatmentConfig> treatments) An array of structures that describe the configuration of each feature variation used in the experiment.
  CreateExperimentRequest	withTreatments (TreatmentConfig... treatments) An array of structures that describe the configuration of each feature variation used 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

  • CreateExperimentRequest

    public CreateExperimentRequest()

• 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 CreateExperimentRequest 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.

  • 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 CreateExperimentRequest 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 CreateExperimentRequest 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.

  • setName

    public void setName(String name)

    A name for the new experiment.

    Parameters:

    name - A name for the new experiment.

  • getName

    public String getName()

    A name for the new experiment.

    Returns:

    A name for the new experiment.

  • withName

    public CreateExperimentRequest withName(String name)

    A name for the new experiment.

    Parameters:

    name - A name for the new experiment.

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

    Parameters:

    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.

  • getOnlineAbConfig

    public OnlineAbConfig getOnlineAbConfig()

    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.

  • withOnlineAbConfig

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

    Parameters:

    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:

    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 you want to create the new experiment in.

    Parameters:

    project - The name or ARN of the project that you want to create the new experiment in.

  • getProject

    public String getProject()

    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.

  • withProject

    public CreateExperimentRequest withProject(String project)

    The name or ARN of the project that you want to create the new experiment in.

    Parameters:

    project - The name or ARN of the project that you want to create the new experiment in.

    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 CreateExperimentRequest 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.

  • 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 10,000 to allocate 10% 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 10,000 to allocate 10% 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 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.

  • withSamplingRate

    public CreateExperimentRequest 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 10,000 to allocate 10% 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 10,000 to allocate 10% 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)

    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.

    Parameters:

    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.

  • getSegment

    public String getSegment()

    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.

  • withSegment

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

    Parameters:

    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:

    Returns a reference to this object so that method calls can be chained together.

  • getTags

    public Map<String,String> getTags()

    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.

    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.

  • setTags

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

    Parameters:

    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.

  • withTags

    public CreateExperimentRequest withTags(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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • addTagsEntry

    public CreateExperimentRequest addTagsEntry(String key,
     String value)

    Add a single Tags entry

    See Also:

    withTags(java.util.Map<java.lang.String, java.lang.String>)

  • clearTagsEntries

    public CreateExperimentRequest clearTagsEntries()

    Removes all the entries added into Tags.

    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 describe the configuration of each feature variation used in the experiment.

    Returns:

    An array of structures that describe the configuration of each feature variation used in the experiment.

  • setTreatments

    public void setTreatments(Collection<TreatmentConfig> treatments)

    An array of structures that describe the configuration of each feature variation used in the experiment.

    Parameters:

    treatments - An array of structures that describe the configuration of each feature variation used in the experiment.

  • withTreatments

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

    Parameters:

    treatments - An array of structures that describe the configuration of each feature variation used in the experiment.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withTreatments

    public CreateExperimentRequest withTreatments(Collection<TreatmentConfig> treatments)

    An array of structures that describe the configuration of each feature variation used in the experiment.

    Parameters:

    treatments - An array of structures that describe the configuration of each feature variation used 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 CreateExperimentRequest 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()