java.lang.Object
- software.amazon.awssdk.services.glue.model.DataQualityResult

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DataQualityResult.Builder,DataQualityResult>

@Generated("software.amazon.awssdk:codegen")
public final class DataQualityResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DataQualityResult.Builder,DataQualityResult>

Describes a data quality result.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DataQualityResult.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<DataQualityAnalyzerResult>`	`analyzerResults()`	A list of `DataQualityAnalyzerResult` objects representing the results for each analyzer.
`static DataQualityResult.Builder`	`builder()`
`Instant`	`completedOn()`	The date and time when this data quality run completed.
`DataSource`	`dataSource()`	The table associated with the data quality result, if any.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`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.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAnalyzerResults()`	For responses, this returns true if the service returned a value for the AnalyzerResults property.
`int`	`hashCode()`
`boolean`	`hasObservations()`	For responses, this returns true if the service returned a value for the Observations property.
`boolean`	`hasRuleResults()`	For responses, this returns true if the service returned a value for the RuleResults property.
`String`	`jobName()`	The job name associated with the data quality result, if any.
`String`	`jobRunId()`	The job run ID associated with the data quality result, if any.
`List<DataQualityObservation>`	`observations()`	A list of `DataQualityObservation` objects representing the observations generated after evaluating the rules and analyzers.
`String`	`resultId()`	A unique result ID for the data quality result.
`List<DataQualityRuleResult>`	`ruleResults()`	A list of `DataQualityRuleResult` objects representing the results for each rule.
`String`	`rulesetEvaluationRunId()`	The unique run ID for the ruleset evaluation for this data quality result.
`String`	`rulesetName()`	The name of the ruleset associated with the data quality result.
`Double`	`score()`	An aggregate data quality score.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DataQualityResult.Builder>`	`serializableBuilderClass()`
`Instant`	`startedOn()`	The date and time when this data quality run started.
`DataQualityResult.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - resultId
```
public final String resultId()
```
    A unique result ID for the data quality result.
    
    Returns:
    
    A unique result 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 this data quality run started.
    
    Returns:
    
    The date and time when this data quality run started.
  - completedOn
```
public final Instant completedOn()
```
    The date and time when this data quality run completed.
    
    Returns:
    
    The date and time when this data quality run 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 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 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.
  - toBuilder
```
public DataQualityResult.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DataQualityResult.Builder,DataQualityResult>
  - builder
```
public static DataQualityResult.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DataQualityResult.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DataQualityResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

resultId

score

dataSource

rulesetName

evaluationContext

startedOn

completedOn

jobName

jobRunId

rulesetEvaluationRunId

hasRuleResults

ruleResults

hasAnalyzerResults

analyzerResults

hasObservations

observations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields