Package software.amazon.awssdk.services.glue.model

Class DataQualityRuleResult

java.lang.Object

software.amazon.awssdk.services.glue.model.DataQualityRuleResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DataQualityRuleResult.Builder,DataQualityRuleResult>

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

Describes the result of the evaluation of a data quality rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataQualityRuleResult.Builder

Method Summary

Modifier and Type	Method	Description
static DataQualityRuleResult.Builder	builder()
String	description()	A description of the data quality rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,Double>	evaluatedMetrics()	A map of metrics associated with the evaluation of the rule.
String	evaluationMessage()	An evaluation message.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEvaluatedMetrics()	For responses, this returns true if the service returned a value for the EvaluatedMetrics property.
int	hashCode()
String	name()	The name of the data quality rule.
DataQualityRuleResultStatus	result()	A pass or fail status for the rule.
String	resultAsString()	A pass or fail status for the rule.
List<SdkField<?>>	sdkFields()
static Class<? extends DataQualityRuleResult.Builder>	serializableBuilderClass()
DataQualityRuleResult.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

name

public final String name()

The name of the data quality rule.

Returns:

The name of the data quality rule.

description

public final String description()

A description of the data quality rule.

Returns:

A description of the data quality rule.

evaluationMessage

public final String evaluationMessage()

An evaluation message.

Returns:

An evaluation message.

result

public final DataQualityRuleResultStatus result()

A pass or fail status for the rule.

If the service returns an enum value that is not available in the current SDK version, result will return DataQualityRuleResultStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultAsString().

Returns:

A pass or fail status for the rule.

See Also:

DataQualityRuleResultStatus

resultAsString

public final String resultAsString()

A pass or fail status for the rule.

If the service returns an enum value that is not available in the current SDK version, result will return DataQualityRuleResultStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultAsString().

Returns:

A pass or fail status for the rule.

See Also:

DataQualityRuleResultStatus

hasEvaluatedMetrics

public final boolean hasEvaluatedMetrics()

For responses, this returns true if the service returned a value for the EvaluatedMetrics 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.

evaluatedMetrics

public final Map<String,Double> evaluatedMetrics()

A map of metrics associated with the evaluation of the 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 hasEvaluatedMetrics() method.

Returns:

A map of metrics associated with the evaluation of the rule.

toBuilder

public DataQualityRuleResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataQualityRuleResult.Builder,DataQualityRuleResult>

builder

public static DataQualityRuleResult.Builder builder()

serializableBuilderClass

public static Class<? extends DataQualityRuleResult.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