Class DataQualityResult
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DataQualityResult.Builder,
DataQualityResult>
Describes a data quality result.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<DataQualityAnalyzerResult> A list ofDataQualityAnalyzerResult
objects representing the results for each analyzer.static DataQualityResult.Builder
builder()
final Instant
The date and time when this data quality run completed.final DataSource
The table associated with the data quality result, if any.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
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.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AnalyzerResults property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Observations property.final boolean
For responses, this returns true if the service returned a value for the RuleResults property.final String
jobName()
The job name associated with the data quality result, if any.final String
jobRunId()
The job run ID associated with the data quality result, if any.final List
<DataQualityObservation> A list ofDataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.final String
resultId()
A unique result ID for the data quality result.final List
<DataQualityRuleResult> A list ofDataQualityRuleResult
objects representing the results for each rule.final String
The unique run ID for the ruleset evaluation for this data quality result.final String
The name of the ruleset associated with the data quality result.final Double
score()
An aggregate data quality score.static Class
<? extends DataQualityResult.Builder> final Instant
The date and time when this data quality run started.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resultId
A unique result ID for the data quality result.
- Returns:
- A unique result ID for the data quality result.
-
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
The table associated with the data quality result, if any.
- Returns:
- The table associated with the data quality result, if any.
-
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
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
The date and time when this data quality run started.
- Returns:
- The date and time when this data quality run started.
-
completedOn
The date and time when this data quality run completed.
- Returns:
- The date and time when this data quality run completed.
-
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
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
The unique run ID for the ruleset evaluation for this data quality result.
- Returns:
- The unique run ID for the ruleset evaluation for this data quality result.
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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.
-
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 interfaceToCopyableBuilder<DataQualityResult.Builder,
DataQualityResult> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-