Interface DataQualityResult.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DataQualityResult.Builder,DataQualityResult>, SdkBuilder<DataQualityResult.Builder,DataQualityResult>, SdkPojo
Enclosing class:
DataQualityResult
@Mutable @NotThreadSafe public static interface DataQualityResult.Builder extends SdkPojo, CopyableBuilder<DataQualityResult.Builder,DataQualityResult>

  • Method Details

    • resultId

      DataQualityResult.Builder resultId(String resultId)

      A unique result ID for the data quality result.

      Parameters:
      resultId - A unique result ID for the data quality result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profileId

      DataQualityResult.Builder profileId(String profileId)

      The Profile ID for the data quality result.

      Parameters:
      profileId - The Profile ID for the data quality result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • score

      DataQualityResult.Builder score(Double score)

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

      Parameters:
      score - An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSource

      DataQualityResult.Builder dataSource(DataSource dataSource)

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

      Parameters:
      dataSource - The table associated with the data quality result, if any.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSource

      default DataQualityResult.Builder dataSource(Consumer<DataSource.Builder> dataSource)

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

      This is a convenience method that creates an instance of the DataSource.Builder avoiding the need to create one manually via DataSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSource(DataSource).

      Parameters:
      dataSource - a consumer that will call methods on DataSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rulesetName

      DataQualityResult.Builder rulesetName(String rulesetName)

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

      Parameters:
      rulesetName - The name of the ruleset associated with the data quality result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evaluationContext

      DataQualityResult.Builder evaluationContext(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • startedOn

      DataQualityResult.Builder startedOn(Instant startedOn)

      The date and time when this data quality run started.

      Parameters:
      startedOn - The date and time when this data quality run started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completedOn

      DataQualityResult.Builder completedOn(Instant completedOn)

      The date and time when this data quality run completed.

      Parameters:
      completedOn - The date and time when this data quality run completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobName

      DataQualityResult.Builder jobName(String jobName)

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

      Parameters:
      jobName - The job name associated with the data quality result, if any.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobRunId

      DataQualityResult.Builder jobRunId(String jobRunId)

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

      Parameters:
      jobRunId - The job run ID associated with the data quality result, if any.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rulesetEvaluationRunId

      DataQualityResult.Builder rulesetEvaluationRunId(String rulesetEvaluationRunId)

      The unique run ID for the ruleset evaluation for this data quality result.

      Parameters:
      rulesetEvaluationRunId - The unique run ID for the ruleset evaluation for this data quality result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleResults

      DataQualityResult.Builder ruleResults(Collection<DataQualityRuleResult> ruleResults)

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

      Parameters:
      ruleResults - A list of DataQualityRuleResult objects representing the results for each rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleResults

      DataQualityResult.Builder ruleResults(DataQualityRuleResult... ruleResults)

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

      Parameters:
      ruleResults - A list of DataQualityRuleResult objects representing the results for each rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleResults

      DataQualityResult.Builder ruleResults(Consumer<DataQualityRuleResult.Builder>... ruleResults)

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

      This is a convenience method that creates an instance of the DataQualityRuleResult.Builder avoiding the need to create one manually via DataQualityRuleResult.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleResults(List<DataQualityRuleResult>).

      Parameters:
      ruleResults - a consumer that will call methods on DataQualityRuleResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • analyzerResults

      DataQualityResult.Builder analyzerResults(Collection<DataQualityAnalyzerResult> analyzerResults)

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

      Parameters:
      analyzerResults - A list of DataQualityAnalyzerResult objects representing the results for each analyzer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analyzerResults

      DataQualityResult.Builder analyzerResults(DataQualityAnalyzerResult... analyzerResults)

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

      Parameters:
      analyzerResults - A list of DataQualityAnalyzerResult objects representing the results for each analyzer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analyzerResults

      DataQualityResult.Builder analyzerResults(Consumer<DataQualityAnalyzerResult.Builder>... analyzerResults)

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

      This is a convenience method that creates an instance of the DataQualityAnalyzerResult.Builder avoiding the need to create one manually via DataQualityAnalyzerResult.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to analyzerResults(List<DataQualityAnalyzerResult>).

      Parameters:
      analyzerResults - a consumer that will call methods on DataQualityAnalyzerResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • observations

      DataQualityResult.Builder observations(Collection<DataQualityObservation> observations)

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

      Parameters:
      observations - A list of DataQualityObservation objects representing the observations generated after evaluating the rules and analyzers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • observations

      DataQualityResult.Builder observations(DataQualityObservation... observations)

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

      Parameters:
      observations - A list of DataQualityObservation objects representing the observations generated after evaluating the rules and analyzers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • observations

      DataQualityResult.Builder observations(Consumer<DataQualityObservation.Builder>... observations)

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

      This is a convenience method that creates an instance of the DataQualityObservation.Builder avoiding the need to create one manually via DataQualityObservation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to observations(List<DataQualityObservation>).

      Parameters:
      observations - a consumer that will call methods on DataQualityObservation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • aggregatedMetrics

      DataQualityResult.Builder aggregatedMetrics(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • aggregatedMetrics

      default DataQualityResult.Builder aggregatedMetrics(Consumer<DataQualityAggregatedMetrics.Builder> 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.

      This is a convenience method that creates an instance of the DataQualityAggregatedMetrics.Builder avoiding the need to create one manually via DataQualityAggregatedMetrics.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to aggregatedMetrics(DataQualityAggregatedMetrics).

      Parameters:
      aggregatedMetrics - a consumer that will call methods on DataQualityAggregatedMetrics.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: