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

Class OnlineAbConfig

java.lang.Object
software.amazon.awssdk.services.evidently.model.OnlineAbConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OnlineAbConfig.Builder,OnlineAbConfig>
@Generated("software.amazon.awssdk:codegen") public final class OnlineAbConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OnlineAbConfig.Builder,OnlineAbConfig>

A structure that contains the configuration of which variation to 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.

See Also:

  • Method Details

    • controlTreatmentName

      public final String controlTreatmentName()

      The name of the variation that is to be the default variation that the other variations are compared to.

      Returns:
      The name of the variation that is to be the default variation that the other variations are compared to.

    • hasTreatmentWeights

      public final boolean hasTreatmentWeights()
      For responses, this returns true if the service returned a value for the TreatmentWeights 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.

    • treatmentWeights

      public final Map<String,Long> treatmentWeights()

      A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

      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 hasTreatmentWeights() method.

      Returns:
      A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

    • toBuilder

      public OnlineAbConfig.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<OnlineAbConfig.Builder,OnlineAbConfig>
      Returns:
      a builder for type T

    • builder

      public static OnlineAbConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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