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

Class Treatment

java.lang.Object

software.amazon.awssdk.services.evidently.model.Treatment

All Implemented Interfaces:

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

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

A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Treatment.Builder

Method Summary

Modifier and Type	Method	Description
static Treatment.Builder	builder()
String	description()	The description of the treatment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,String>	featureVariations()	The feature variation used for this treatment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFeatureVariations()	For responses, this returns true if the service returned a value for the FeatureVariations property.
int	hashCode()
String	name()	The name of this treatment.
List<SdkField<?>>	sdkFields()
static Class<? extends Treatment.Builder>	serializableBuilderClass()
Treatment.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

description

public final String description()

The description of the treatment.

Returns:

The description of the treatment.

hasFeatureVariations

public final boolean hasFeatureVariations()

For responses, this returns true if the service returned a value for the FeatureVariations 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.

featureVariations

public final Map<String,String> featureVariations()

The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

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

Returns:

The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

name

public final String name()

The name of this treatment.

Returns:

The name of this treatment.

toBuilder

public Treatment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Treatment.Builder,Treatment>

builder

public static Treatment.Builder builder()

serializableBuilderClass

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