software.amazon.awssdk.services.evidently.model

Class ExperimentResultsData

java.lang.Object

software.amazon.awssdk.services.evidently.model.ExperimentResultsData

All Implemented Interfaces:

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

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

A structure that contains experiment results for one metric that is monitored in the experiment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExperimentResultsData.Builder

Method Summary

Modifier and Type	Method and Description
static ExperimentResultsData.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() For responses, this returns true if the service returned a value for the Values property.
String	metricName() The name of the metric.
ExperimentResultResponseType	resultStat() The experiment statistic that these results pertain to.
String	resultStatAsString() The experiment statistic that these results pertain to.
List<SdkField<?>>	sdkFields()
static Class<? extends ExperimentResultsData.Builder>	serializableBuilderClass()
ExperimentResultsData.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	treatmentName() The treatment, or variation, that returned the values in this structure.
List<Double>	values() The values for the metricName that were recorded in the experiment.

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

metricName

public final String metricName()

The name of the metric.

Returns:

The name of the metric.

resultStat

public final ExperimentResultResponseType resultStat()

The experiment statistic that these results pertain to.

If the service returns an enum value that is not available in the current SDK version, resultStat will return ExperimentResultResponseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultStatAsString().

Returns:

The experiment statistic that these results pertain to.

See Also:

ExperimentResultResponseType

resultStatAsString

public final String resultStatAsString()

The experiment statistic that these results pertain to.

If the service returns an enum value that is not available in the current SDK version, resultStat will return ExperimentResultResponseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultStatAsString().

Returns:

The experiment statistic that these results pertain to.

See Also:

ExperimentResultResponseType

treatmentName

public final String treatmentName()

The treatment, or variation, that returned the values in this structure.

Returns:

The treatment, or variation, that returned the values in this structure.

hasValues

public final boolean hasValues()

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

values

public final List<Double> values()

The values for the metricName that were recorded 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 hasValues() method.

Returns:

The values for the metricName that were recorded in the experiment.

toBuilder

public ExperimentResultsData.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExperimentResultsData.Builder,ExperimentResultsData>

builder

public static ExperimentResultsData.Builder builder()

serializableBuilderClass

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