Class DataQualityMetric

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

An array that describes a data quality metric. Each DataQualityMetric object contains the data quality metric name, its value, a description of the metric, and the affected column.

See Also:

  • Method Details

    • metricType

      public final DataQualityMetricType metricType()

      The name of the data quality metric.

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

      Returns:
      The name of the data quality metric.
      See Also:

    • metricTypeAsString

      public final String metricTypeAsString()

      The name of the data quality metric.

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

      Returns:
      The name of the data quality metric.
      See Also:

    • metricDescription

      public final String metricDescription()

      A description of the data quality metric.

      Returns:
      A description of the data quality metric.

    • relatedColumnName

      public final String relatedColumnName()

      The column that is being monitored.

      Returns:
      The column that is being monitored.

    • metricValue

      public final Double metricValue()

      The value of the data quality metric.

      Returns:
      The value of the data quality metric.

    • toBuilder

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

    • builder

      public static DataQualityMetric.Builder builder()

    • serializableBuilderClass

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