Class GetDataQualityResultResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.glue.model.GlueResponse
software.amazon.awssdk.services.glue.model.GetDataQualityResultResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDataQualityResultResponse.Builder,GetDataQualityResultResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDataQualityResultResponse extends GlueResponse implements ToCopyableBuilder<GetDataQualityResultResponse.Builder,GetDataQualityResultResponse>

The response for the data quality result.

  • 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.

    • profileId

      public final String profileId()

      The Profile ID for the data quality result.

      Returns:
      The Profile ID for the data quality result.

    • 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.

    • 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.

    • 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.

    • evaluationContext

      public final String evaluationContext()

      In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.

      Returns:
      In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.

    • startedOn

      public final Instant startedOn()

      The date and time when the run for this data quality result started.

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

    • completedOn

      public final Instant completedOn()

      The date and time when the run for this data quality result was completed.

      Returns:
      The date and time when the run for this data quality result was completed.

    • jobName

      public final String jobName()

      The job name associated with the data quality result, if any.

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

    • jobRunId

      public final String jobRunId()

      The job run ID associated with the data quality result, if any.

      Returns:
      The job run ID associated with the data quality result, if any.

    • rulesetEvaluationRunId

      public final String rulesetEvaluationRunId()

      The unique run ID associated with the ruleset evaluation.

      Returns:
      The unique run ID associated with the ruleset evaluation.

    • 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 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 observations generated after evaluating the rules and analyzers.

    • 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.

    • toBuilder

      public GetDataQualityResultResponse.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<GetDataQualityResultResponse.Builder,GetDataQualityResultResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetDataQualityResultResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetDataQualityResultResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.