Package software.amazon.awssdk.services.sagemaker.model

Class ClarifyCheckStepMetadata

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ClarifyCheckStepMetadata

All Implemented Interfaces:

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

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

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClarifyCheckStepMetadata.Builder

Method Summary

Modifier and Type	Method	Description
String	baselineUsedForDriftCheckConstraints()	The Amazon S3 URI of baseline constraints file to be used for the drift check.
static ClarifyCheckStepMetadata.Builder	builder()
String	calculatedBaselineConstraints()	The Amazon S3 URI of the newly calculated baseline constraints file.
String	checkJobArn()	The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
String	checkType()	The type of the Clarify Check step
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	modelPackageGroupName()	The model package group name.
Boolean	registerNewBaseline()	This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ClarifyCheckStepMetadata.Builder>	serializableBuilderClass()
Boolean	skipCheck()	This flag indicates if the drift check against the previous baseline will be skipped or not.
ClarifyCheckStepMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	violationReport()	The Amazon S3 URI of the violation report if violations are detected.

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

checkType

public final String checkType()

The type of the Clarify Check step

Returns:

The type of the Clarify Check step

baselineUsedForDriftCheckConstraints

public final String baselineUsedForDriftCheckConstraints()

The Amazon S3 URI of baseline constraints file to be used for the drift check.

Returns:

The Amazon S3 URI of baseline constraints file to be used for the drift check.

calculatedBaselineConstraints

public final String calculatedBaselineConstraints()

The Amazon S3 URI of the newly calculated baseline constraints file.

Returns:

The Amazon S3 URI of the newly calculated baseline constraints file.

modelPackageGroupName

public final String modelPackageGroupName()

The model package group name.

Returns:

The model package group name.

violationReport

public final String violationReport()

The Amazon S3 URI of the violation report if violations are detected.

Returns:

The Amazon S3 URI of the violation report if violations are detected.

checkJobArn

public final String checkJobArn()

The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

Returns:

The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

skipCheck

public final Boolean skipCheck()

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

Returns:

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

registerNewBaseline

public final Boolean registerNewBaseline()

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

Returns:

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

toBuilder

public ClarifyCheckStepMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClarifyCheckStepMetadata.Builder,ClarifyCheckStepMetadata>

builder

public static ClarifyCheckStepMetadata.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo