Class DataQualityResultV2Item

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

Describes a data quality result returned by BatchGetDataQualityResultV2.

See Also:

  • Method Details

    • resultId

      public final String resultId()

      A unique result ID for the data quality result.

      Returns:
      A unique result ID for the data quality result.

    • dataSource

      public final DataSource dataSource()

      The table associated with the data quality result, if any.

      Returns:
      The table associated with the data quality result, if any.

    • hasDimensions

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

    • dimensions

      public final Map<String,String> dimensions()

      A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.

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

      Returns:
      A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A map of tags associated with the data quality result.

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

      Returns:
      A map of tags associated with the data quality result.

    • executionStartedOn

      public final Instant executionStartedOn()

      The date and time when this data quality run started.

      Returns:
      The date and time when this data quality run started.

    • executionCompletedOn

      public final Instant executionCompletedOn()

      The date and time when this data quality run completed.

      Returns:
      The date and time when this data quality run completed.

    • resultPublishedOn

      public final Instant resultPublishedOn()

      The date and time when this data quality result was published.

      Returns:
      The date and time when this data quality result was published.

    • score

      public final Double score()

      An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.

      Returns:
      An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.

    • hasRuleResults

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

    • ruleResults

      public final List<DataQualityRuleResult> ruleResults()

      A list of DataQualityRuleResult objects representing the results for each rule.

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

      Returns:
      A list of DataQualityRuleResult objects representing the results for each rule.

    • hasAnalyzerResults

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

    • analyzerResults

      public final List<DataQualityAnalyzerResult> analyzerResults()

      A list of DataQualityAnalyzerResult objects representing the results for each analyzer.

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

      Returns:
      A list of DataQualityAnalyzerResult objects representing the results for each analyzer.

    • hasObservations

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

    • observations

      public final List<DataQualityObservation> observations()

      A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.

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

      Returns:
      A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.

    • evaluationContext

      public final String evaluationContext()

      The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.

      Returns:
      The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.

    • hasDescriptors

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

    • descriptors

      public final Map<String,String> descriptors()

      A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.

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

      Returns:
      A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.

    • aggregatedMetrics

      public final DataQualityAggregatedMetrics aggregatedMetrics()

      A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.

      Returns:
      A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.

    • rulesetName

      public final String rulesetName()

      The name of the ruleset associated with the data quality result.

      Returns:
      The name of the ruleset associated with the data quality result.

    • toBuilder

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

    • builder

      public static DataQualityResultV2Item.Builder builder()

    • serializableBuilderClass

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