Package 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("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:

  • Method Details

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

    • 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)
      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.