Package software.amazon.awssdk.services.personalize.model

Class MetricAttribute

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

Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.

See Also:

  • Method Details

    • eventType

      public final String eventType()

      The metric's event type.

      Returns:
      The metric's event type.

    • metricName

      public final String metricName()

      The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

      Returns:
      The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

    • expression

      public final String expression()

      The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

      Returns:
      The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

    • toBuilder

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

    • builder

      public static MetricAttribute.Builder builder()

    • serializableBuilderClass

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