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

Interface CreateExperimentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateExperimentRequest.Builder,CreateExperimentRequest>, EvidentlyRequest.Builder, SdkBuilder<CreateExperimentRequest.Builder,CreateExperimentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateExperimentRequest
public static interface CreateExperimentRequest.Builder extends EvidentlyRequest.Builder, SdkPojo, CopyableBuilder<CreateExperimentRequest.Builder,CreateExperimentRequest>

  • Method Details

    • description

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

    • metricGoals

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

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

    • metricGoals

      CreateExperimentRequest.Builder metricGoals(Consumer<MetricGoalConfig.Builder>... 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.

      This is a convenience method that creates an instance of the MetricGoalConfig.Builder avoiding the need to create one manually via MetricGoalConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricGoals(List<MetricGoalConfig>).

      Parameters:
      metricGoals - a consumer that will call methods on MetricGoalConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      CreateExperimentRequest.Builder name(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.

    • onlineAbConfig

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

    • onlineAbConfig

      default CreateExperimentRequest.Builder onlineAbConfig(Consumer<OnlineAbConfig.Builder> 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.

      This is a convenience method that creates an instance of the OnlineAbConfig.Builder avoiding the need to create one manually via OnlineAbConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onlineAbConfig(OnlineAbConfig).

      Parameters:
      onlineAbConfig - a consumer that will call methods on OnlineAbConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • project

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

    • randomizationSalt

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

    • samplingRate

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

    • segment

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

    • tags

      CreateExperimentRequest.Builder tags(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.

    • treatments

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

    • treatments

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

    • treatments

      CreateExperimentRequest.Builder treatments(Consumer<TreatmentConfig.Builder>... treatments)

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

      This is a convenience method that creates an instance of the TreatmentConfig.Builder avoiding the need to create one manually via TreatmentConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to treatments(List<TreatmentConfig>).

      Parameters:
      treatments - a consumer that will call methods on TreatmentConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateExperimentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateExperimentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.