Class AudienceQualityMetrics

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

Metrics that describe the quality of the generated audience.

See Also:

  • Method Details

    • hasRelevanceMetrics

      public final boolean hasRelevanceMetrics()
      For responses, this returns true if the service returned a value for the RelevanceMetrics 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.

    • relevanceMetrics

      public final List<RelevanceMetric> relevanceMetrics()

      The relevance scores of the generated audience.

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

      Returns:
      The relevance scores of the generated audience.

    • recallMetric

      public final Double recallMetric()

      The recall score of the generated audience. Recall is the percentage of the most similar users (by default, the most similar 20%) from a sample of the training data that are included in the seed audience by the audience generation job. Values range from 0-1, larger values indicate a better audience. A recall value approximately equal to the maximum bin size indicates that the audience model is equivalent to random selection.

      Returns:
      The recall score of the generated audience. Recall is the percentage of the most similar users (by default, the most similar 20%) from a sample of the training data that are included in the seed audience by the audience generation job. Values range from 0-1, larger values indicate a better audience. A recall value approximately equal to the maximum bin size indicates that the audience model is equivalent to random selection.

    • toBuilder

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

    • builder

      public static AudienceQualityMetrics.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.