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

Class OnlineAbDefinition

java.lang.Object

software.amazon.awssdk.services.evidently.model.OnlineAbDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OnlineAbDefinition.Builder,OnlineAbDefinition>

@Generated("software.amazon.awssdk:codegen")
public final class OnlineAbDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OnlineAbDefinition.Builder,OnlineAbDefinition>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OnlineAbDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static OnlineAbDefinition.Builder	builder()
String	controlTreatmentName()	The name of the variation that is the default variation that the other variations are compared to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTreatmentWeights()	For responses, this returns true if the service returned a value for the TreatmentWeights property.
List<SdkField<?>>	sdkFields()
static Class<? extends OnlineAbDefinition.Builder>	serializableBuilderClass()
OnlineAbDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Map<String,Long>	treatmentWeights()	A set of key-value pairs.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

controlTreatmentName

public final String controlTreatmentName()

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

Returns:

The name of the variation that is 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. The traffic portion is specified 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. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

toBuilder

public OnlineAbDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OnlineAbDefinition.Builder,OnlineAbDefinition>

builder

public static OnlineAbDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends OnlineAbDefinition.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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