software.amazon.awssdk.services.sagemaker.model

Class QualityCheckStepMetadata

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.QualityCheckStepMetadata

All Implemented Interfaces:

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

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

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QualityCheckStepMetadata.Builder

Method Summary

Modifier and Type	Method and Description
String	baselineUsedForDriftCheckConstraints() The Amazon S3 URI of the baseline constraints file used for the drift check.
String	baselineUsedForDriftCheckStatistics() The Amazon S3 URI of the baseline statistics file used for the drift check.
static QualityCheckStepMetadata.Builder	builder()
String	calculatedBaselineConstraints() The Amazon S3 URI of the newly calculated baseline constraints file.
String	calculatedBaselineStatistics() The Amazon S3 URI of the newly calculated baseline statistics file.
String	checkJobArn() The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
String	checkType() The type of the Quality 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.
List<SdkField<?>>	sdkFields()
static Class<? extends QualityCheckStepMetadata.Builder>	serializableBuilderClass()
Boolean	skipCheck() This flag indicates if the drift check against the previous baseline will be skipped or not.
QualityCheckStepMetadata.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	violationReport() The Amazon S3 URI of 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 Quality check step.

Returns:

The type of the Quality check step.

baselineUsedForDriftCheckStatistics

public final String baselineUsedForDriftCheckStatistics()

The Amazon S3 URI of the baseline statistics file used for the drift check.

Returns:

The Amazon S3 URI of the baseline statistics file used for the drift check.

baselineUsedForDriftCheckConstraints

public final String baselineUsedForDriftCheckConstraints()

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

Returns:

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

calculatedBaselineStatistics

public final String calculatedBaselineStatistics()

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

Returns:

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

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 violation report if violations are detected.

Returns:

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

checkJobArn

public final String checkJobArn()

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

Returns:

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step 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 and BaselineUsedForDriftCheckStatistics properties.

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 and BaselineUsedForDriftCheckStatistics properties.

toBuilder

public QualityCheckStepMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QualityCheckStepMetadata.Builder,QualityCheckStepMetadata>

builder

public static QualityCheckStepMetadata.Builder builder()

serializableBuilderClass

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