software.amazon.awssdk.services.evidently.model

Class MetricDefinition

java.lang.Object

software.amazon.awssdk.services.evidently.model.MetricDefinition

All Implemented Interfaces:

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

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

This structure defines a metric that is being used to evaluate the variations during a launch or experiment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricDefinition.Builder

Method Summary

Modifier and Type	Method and Description
static MetricDefinition.Builder	builder()
String	entityIdKey() The entity, such as a user or session, that does an action that causes a metric value to be recorded.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventPattern() The EventBridge event pattern that defines how the metric is recorded.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the metric.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricDefinition.Builder>	serializableBuilderClass()
MetricDefinition.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	unitLabel() The label for the units that the metric is measuring.
String	valueKey() The value that is tracked to produce the metric.

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

entityIdKey

public final String entityIdKey()

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

Returns:

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

eventPattern

public final String eventPattern()

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

Returns:

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

name

public final String name()

The name of the metric.

Returns:

The name of the metric.

unitLabel

public final String unitLabel()

The label for the units that the metric is measuring.

Returns:

The label for the units that the metric is measuring.

valueKey

public final String valueKey()

The value that is tracked to produce the metric.

Returns:

The value that is tracked to produce the metric.

toBuilder

public MetricDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricDefinition.Builder,MetricDefinition>

builder

public static MetricDefinition.Builder builder()

serializableBuilderClass

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