Class MetricBasedObservation

    • Method Detail

      • metricName

        public final String metricName()

        The name of the data quality metric used for generating the observation.

        Returns:
        The name of the data quality metric used for generating the observation.
      • statisticId

        public final String statisticId()

        The Statistic ID.

        Returns:
        The Statistic ID.
      • metricValues

        public final DataQualityMetricValues metricValues()

        An object of type DataQualityMetricValues representing the analysis of the data quality metric value.

        Returns:
        An object of type DataQualityMetricValues representing the analysis of the data quality metric value.
      • hasNewRules

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

        public final List<String> newRules()

        A list of new data quality rules generated as part of the observation based on the data quality metric value.

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

        Returns:
        A list of new data quality rules generated as part of the observation based on the data quality metric value.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)