Interface DataQualityResultV2Item.Builder

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

  • Method Details

    • resultId

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

    • dataSource

      DataQualityResultV2Item.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 DataQualityResultV2Item.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:

    • dimensions

      DataQualityResultV2Item.Builder dimensions(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.

      Parameters:
      dimensions - A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DataQualityResultV2Item.Builder tags(Map<String,String> tags)

      A map of tags associated with the data quality result.

      Parameters:
      tags - A map of tags associated with the data quality result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionStartedOn

      DataQualityResultV2Item.Builder executionStartedOn(Instant executionStartedOn)

      The date and time when this data quality run started.

      Parameters:
      executionStartedOn - 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.

    • executionCompletedOn

      DataQualityResultV2Item.Builder executionCompletedOn(Instant executionCompletedOn)

      The date and time when this data quality run completed.

      Parameters:
      executionCompletedOn - 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.

    • resultPublishedOn

      DataQualityResultV2Item.Builder resultPublishedOn(Instant resultPublishedOn)

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

      Parameters:
      resultPublishedOn - The date and time when this data quality result was published.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • score

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

    • ruleResults

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

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

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

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

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

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

      DataQualityResultV2Item.Builder observations(Collection<DataQualityObservation> observations)

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

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

    • observations

      DataQualityResultV2Item.Builder observations(DataQualityObservation... observations)

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

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

    • observations

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

      A list of DataQualityObservation objects representing the anomaly detection 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:

    • evaluationContext

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

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

    • descriptors

      DataQualityResultV2Item.Builder descriptors(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.

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

    • aggregatedMetrics

      DataQualityResultV2Item.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 DataQualityResultV2Item.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:

    • rulesetName

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