Class UpdateExperimentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.evidently.model.EvidentlyRequest
software.amazon.awssdk.services.evidently.model.UpdateExperimentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateExperimentRequest extends EvidentlyRequest implements ToCopyableBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>

  • Method Details

    • description

      public final String description()

      An optional description of the experiment.

      Returns:
      An optional description of the experiment.

    • experiment

      public final String experiment()

      The name of the experiment to update.

      Returns:
      The name of the experiment to update.

    • hasMetricGoals

      public final boolean hasMetricGoals()
      For responses, this returns true if the service returned a value for the MetricGoals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • metricGoals

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricGoals() method.

      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.

    • onlineAbConfig

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

      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.

    • project

      public final String project()

      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.

    • randomizationSalt

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

      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.

    • removeSegment

      public final Boolean removeSegment()

      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.

    • samplingRate

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

      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.

    • segment

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

      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.

    • hasTreatments

      public final boolean hasTreatments()
      For responses, this returns true if the service returned a value for the Treatments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • treatments

      public final List<TreatmentConfig> treatments()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTreatments() method.

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

    • toBuilder

      public UpdateExperimentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>
      Specified by:
      toBuilder in class EvidentlyRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateExperimentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateExperimentRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.