Package software.amazon.awssdk.services.evidently.model

Interface UpdateExperimentRequest.Builder

    • Method Detail

      • description

        UpdateExperimentRequest.Builder description​(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.

      • experiment

        UpdateExperimentRequest.Builder experiment​(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.

      • metricGoals

        UpdateExperimentRequest.Builder metricGoals​(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.

      • metricGoals

        UpdateExperimentRequest.Builder metricGoals​(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.

      • onlineAbConfig

        UpdateExperimentRequest.Builder onlineAbConfig​(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.

      • project

        UpdateExperimentRequest.Builder project​(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.

      • randomizationSalt

        UpdateExperimentRequest.Builder randomizationSalt​(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.

      • removeSegment

        UpdateExperimentRequest.Builder removeSegment​(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.

      • samplingRate

        UpdateExperimentRequest.Builder samplingRate​(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.

      • segment

        UpdateExperimentRequest.Builder segment​(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.

      • treatments

        UpdateExperimentRequest.Builder treatments​(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.

      • treatments

        UpdateExperimentRequest.Builder treatments​(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.