Interface GetDataQualityResultResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetDataQualityResultResponse.Builder,
,GetDataQualityResultResponse> GlueResponse.Builder
,SdkBuilder<GetDataQualityResultResponse.Builder,
,GetDataQualityResultResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetDataQualityResultResponse
-
Method Summary
Modifier and TypeMethodDescriptionaggregatedMetrics
(Consumer<DataQualityAggregatedMetrics.Builder> aggregatedMetrics) A summary ofDataQualityAggregatedMetrics
objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.aggregatedMetrics
(DataQualityAggregatedMetrics aggregatedMetrics) A summary ofDataQualityAggregatedMetrics
objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.analyzerResults
(Collection<DataQualityAnalyzerResult> analyzerResults) A list ofDataQualityAnalyzerResult
objects representing the results for each analyzer.analyzerResults
(Consumer<DataQualityAnalyzerResult.Builder>... analyzerResults) A list ofDataQualityAnalyzerResult
objects representing the results for each analyzer.analyzerResults
(DataQualityAnalyzerResult... analyzerResults) A list ofDataQualityAnalyzerResult
objects representing the results for each analyzer.completedOn
(Instant completedOn) The date and time when the run for this data quality result was completed.dataSource
(Consumer<DataSource.Builder> dataSource) The table associated with the data quality result, if any.dataSource
(DataSource dataSource) The table associated with the data quality result, if any.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.The job name associated with the data quality result, if any.The job run ID associated with the data quality result, if any.observations
(Collection<DataQualityObservation> observations) A list ofDataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.observations
(Consumer<DataQualityObservation.Builder>... observations) A list ofDataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.observations
(DataQualityObservation... observations) A list ofDataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.The Profile ID for the data quality result.A unique result ID for the data quality result.ruleResults
(Collection<DataQualityRuleResult> ruleResults) A list ofDataQualityRuleResult
objects representing the results for each rule.ruleResults
(Consumer<DataQualityRuleResult.Builder>... ruleResults) A list ofDataQualityRuleResult
objects representing the results for each rule.ruleResults
(DataQualityRuleResult... ruleResults) A list ofDataQualityRuleResult
objects representing the results for each rule.rulesetEvaluationRunId
(String rulesetEvaluationRunId) The unique run ID associated with the ruleset evaluation.rulesetName
(String rulesetName) The name of the ruleset associated with the data quality result.An aggregate data quality score.The date and time when the run for this data quality result started.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.glue.model.GlueResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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
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
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
The table associated with the data quality result, if any.
This is a convenience method that creates an instance of theDataSource.Builder
avoiding the need to create one manually viaDataSource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataSource(DataSource)
.- Parameters:
dataSource
- a consumer that will call methods onDataSource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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, theevaluationContext
can differentiate the nodes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startedOn
The date and time when the run for this data quality result started.
- Parameters:
startedOn
- The date and time when the run for this data quality result started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
completedOn
The date and time when the run for this data quality result was completed.
- Parameters:
completedOn
- The date and time when the run for this data quality result was completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
The unique run ID associated with the ruleset evaluation.
- Parameters:
rulesetEvaluationRunId
- The unique run ID associated with the ruleset evaluation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ruleResults
A list of
DataQualityRuleResult
objects representing the results for each rule.- Parameters:
ruleResults
- A list ofDataQualityRuleResult
objects representing the results for each rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ruleResults
A list of
DataQualityRuleResult
objects representing the results for each rule.- Parameters:
ruleResults
- A list ofDataQualityRuleResult
objects representing the results for each rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ruleResults
GetDataQualityResultResponse.Builder ruleResults(Consumer<DataQualityRuleResult.Builder>... ruleResults) A list of
This is a convenience method that creates an instance of theDataQualityRuleResult
objects representing the results for each rule.DataQualityRuleResult.Builder
avoiding the need to create one manually viaDataQualityRuleResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toruleResults(List<DataQualityRuleResult>)
.- Parameters:
ruleResults
- a consumer that will call methods onDataQualityRuleResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
analyzerResults
GetDataQualityResultResponse.Builder analyzerResults(Collection<DataQualityAnalyzerResult> analyzerResults) A list of
DataQualityAnalyzerResult
objects representing the results for each analyzer.- Parameters:
analyzerResults
- A list ofDataQualityAnalyzerResult
objects representing the results for each analyzer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analyzerResults
A list of
DataQualityAnalyzerResult
objects representing the results for each analyzer.- Parameters:
analyzerResults
- A list ofDataQualityAnalyzerResult
objects representing the results for each analyzer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analyzerResults
GetDataQualityResultResponse.Builder analyzerResults(Consumer<DataQualityAnalyzerResult.Builder>... analyzerResults) A list of
This is a convenience method that creates an instance of theDataQualityAnalyzerResult
objects representing the results for each analyzer.DataQualityAnalyzerResult.Builder
avoiding the need to create one manually viaDataQualityAnalyzerResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toanalyzerResults(List<DataQualityAnalyzerResult>)
.- Parameters:
analyzerResults
- a consumer that will call methods onDataQualityAnalyzerResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
observations
A list of
DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.- Parameters:
observations
- A list ofDataQualityObservation
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
A list of
DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.- Parameters:
observations
- A list ofDataQualityObservation
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
GetDataQualityResultResponse.Builder observations(Consumer<DataQualityObservation.Builder>... observations) A list of
This is a convenience method that creates an instance of theDataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.DataQualityObservation.Builder
avoiding the need to create one manually viaDataQualityObservation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toobservations(List<DataQualityObservation>)
.- Parameters:
observations
- a consumer that will call methods onDataQualityObservation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
aggregatedMetrics
GetDataQualityResultResponse.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 ofDataQualityAggregatedMetrics
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 GetDataQualityResultResponse.Builder aggregatedMetrics(Consumer<DataQualityAggregatedMetrics.Builder> aggregatedMetrics) A summary of
This is a convenience method that creates an instance of theDataQualityAggregatedMetrics
objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.DataQualityAggregatedMetrics.Builder
avoiding the need to create one manually viaDataQualityAggregatedMetrics.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaggregatedMetrics(DataQualityAggregatedMetrics)
.- Parameters:
aggregatedMetrics
- a consumer that will call methods onDataQualityAggregatedMetrics.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-