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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<ClarifyCheckStepMetadata.Builder,ClarifyCheckStepMetadata>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.