/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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 AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class QualityCheckStepMetadata implements Serializable, Cloneable, StructuredPojo { /** ** The type of the Quality check step. *
*/ private String checkType; /** ** The Amazon S3 URI of the baseline statistics file used for the drift check. *
*/ private String baselineUsedForDriftCheckStatistics; /** ** The Amazon S3 URI of the baseline constraints file used for the drift check. *
*/ private String baselineUsedForDriftCheckConstraints; /** ** The Amazon S3 URI of the newly calculated baseline statistics file. *
*/ private String calculatedBaselineStatistics; /** ** The Amazon S3 URI of the newly calculated baseline constraints file. *
*/ private String calculatedBaselineConstraints; /** ** The model package group name. *
*/ private String modelPackageGroupName; /** ** The Amazon S3 URI of violation report if violations are detected. *
*/ private String violationReport; /** ** The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution. *
*/ private String checkJobArn; /** *
* 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.
*
* 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.
*
* The type of the Quality check step. *
* * @param checkType * The type of the Quality check step. */ public void setCheckType(String checkType) { this.checkType = checkType; } /** ** The type of the Quality check step. *
* * @return The type of the Quality check step. */ public String getCheckType() { return this.checkType; } /** ** The type of the Quality check step. *
* * @param checkType * The type of the Quality check step. * @return Returns a reference to this object so that method calls can be chained together. */ public QualityCheckStepMetadata withCheckType(String checkType) { setCheckType(checkType); return this; } /** ** The Amazon S3 URI of the baseline statistics file used for the drift check. *
* * @param baselineUsedForDriftCheckStatistics * The Amazon S3 URI of the baseline statistics file used for the drift check. */ public void setBaselineUsedForDriftCheckStatistics(String baselineUsedForDriftCheckStatistics) { this.baselineUsedForDriftCheckStatistics = baselineUsedForDriftCheckStatistics; } /** ** The Amazon S3 URI of the baseline statistics file used for the drift check. *
* * @return The Amazon S3 URI of the baseline statistics file used for the drift check. */ public String getBaselineUsedForDriftCheckStatistics() { return this.baselineUsedForDriftCheckStatistics; } /** ** The Amazon S3 URI of the baseline statistics file used for the drift check. *
* * @param baselineUsedForDriftCheckStatistics * The Amazon S3 URI of the baseline statistics file used for the drift check. * @return Returns a reference to this object so that method calls can be chained together. */ public QualityCheckStepMetadata withBaselineUsedForDriftCheckStatistics(String baselineUsedForDriftCheckStatistics) { setBaselineUsedForDriftCheckStatistics(baselineUsedForDriftCheckStatistics); return this; } /** ** The Amazon S3 URI of the baseline constraints file used for the drift check. *
* * @param baselineUsedForDriftCheckConstraints * The Amazon S3 URI of the baseline constraints file used for the drift check. */ public void setBaselineUsedForDriftCheckConstraints(String baselineUsedForDriftCheckConstraints) { this.baselineUsedForDriftCheckConstraints = baselineUsedForDriftCheckConstraints; } /** ** The Amazon S3 URI of the baseline constraints file used for the drift check. *
* * @return The Amazon S3 URI of the baseline constraints file used for the drift check. */ public String getBaselineUsedForDriftCheckConstraints() { return this.baselineUsedForDriftCheckConstraints; } /** ** The Amazon S3 URI of the baseline constraints file used for the drift check. *
* * @param baselineUsedForDriftCheckConstraints * The Amazon S3 URI of the baseline constraints file used for the drift check. * @return Returns a reference to this object so that method calls can be chained together. */ public QualityCheckStepMetadata withBaselineUsedForDriftCheckConstraints(String baselineUsedForDriftCheckConstraints) { setBaselineUsedForDriftCheckConstraints(baselineUsedForDriftCheckConstraints); return this; } /** ** The Amazon S3 URI of the newly calculated baseline statistics file. *
* * @param calculatedBaselineStatistics * The Amazon S3 URI of the newly calculated baseline statistics file. */ public void setCalculatedBaselineStatistics(String calculatedBaselineStatistics) { this.calculatedBaselineStatistics = calculatedBaselineStatistics; } /** ** The Amazon S3 URI of the newly calculated baseline statistics file. *
* * @return The Amazon S3 URI of the newly calculated baseline statistics file. */ public String getCalculatedBaselineStatistics() { return this.calculatedBaselineStatistics; } /** ** The Amazon S3 URI of the newly calculated baseline statistics file. *
* * @param calculatedBaselineStatistics * The Amazon S3 URI of the newly calculated baseline statistics file. * @return Returns a reference to this object so that method calls can be chained together. */ public QualityCheckStepMetadata withCalculatedBaselineStatistics(String calculatedBaselineStatistics) { setCalculatedBaselineStatistics(calculatedBaselineStatistics); return this; } /** ** The Amazon S3 URI of the newly calculated baseline constraints file. *
* * @param calculatedBaselineConstraints * The Amazon S3 URI of the newly calculated baseline constraints file. */ public void setCalculatedBaselineConstraints(String calculatedBaselineConstraints) { this.calculatedBaselineConstraints = calculatedBaselineConstraints; } /** ** The Amazon S3 URI of the newly calculated baseline constraints file. *
* * @return The Amazon S3 URI of the newly calculated baseline constraints file. */ public String getCalculatedBaselineConstraints() { return this.calculatedBaselineConstraints; } /** ** The Amazon S3 URI of the newly calculated baseline constraints file. *
* * @param calculatedBaselineConstraints * The Amazon S3 URI of the newly calculated baseline constraints file. * @return Returns a reference to this object so that method calls can be chained together. */ public QualityCheckStepMetadata withCalculatedBaselineConstraints(String calculatedBaselineConstraints) { setCalculatedBaselineConstraints(calculatedBaselineConstraints); return this; } /** ** The model package group name. *
* * @param modelPackageGroupName * The model package group name. */ public void setModelPackageGroupName(String modelPackageGroupName) { this.modelPackageGroupName = modelPackageGroupName; } /** ** The model package group name. *
* * @return The model package group name. */ public String getModelPackageGroupName() { return this.modelPackageGroupName; } /** ** The model package group name. *
* * @param modelPackageGroupName * The model package group name. * @return Returns a reference to this object so that method calls can be chained together. */ public QualityCheckStepMetadata withModelPackageGroupName(String modelPackageGroupName) { setModelPackageGroupName(modelPackageGroupName); return this; } /** ** The Amazon S3 URI of violation report if violations are detected. *
* * @param violationReport * The Amazon S3 URI of violation report if violations are detected. */ public void setViolationReport(String violationReport) { this.violationReport = violationReport; } /** ** The Amazon S3 URI of violation report if violations are detected. *
* * @return The Amazon S3 URI of violation report if violations are detected. */ public String getViolationReport() { return this.violationReport; } /** ** The Amazon S3 URI of violation report if violations are detected. *
* * @param violationReport * The Amazon S3 URI of violation report if violations are detected. * @return Returns a reference to this object so that method calls can be chained together. */ public QualityCheckStepMetadata withViolationReport(String violationReport) { setViolationReport(violationReport); return this; } /** ** The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution. *
* * @param checkJobArn * The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution. */ public void setCheckJobArn(String checkJobArn) { this.checkJobArn = checkJobArn; } /** ** The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution. *
* * @return The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution. */ public String getCheckJobArn() { return this.checkJobArn; } /** ** The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution. *
* * @param checkJobArn * The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution. * @return Returns a reference to this object so that method calls can be chained together. */ public QualityCheckStepMetadata withCheckJobArn(String checkJobArn) { setCheckJobArn(checkJobArn); return this; } /** *
* 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.
*
False
, the previous baseline of the configured check type must be available.
*/
public void setSkipCheck(Boolean skipCheck) {
this.skipCheck = 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.
*
False
, the previous baseline of the configured check type must be available.
*/
public Boolean getSkipCheck() {
return this.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.
*
False
, the previous baseline of the configured check type must be available.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QualityCheckStepMetadata withSkipCheck(Boolean skipCheck) {
setSkipCheck(skipCheck);
return this;
}
/**
*
* 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.
*
False
, the previous baseline of the configured check type must be available.
*/
public Boolean isSkipCheck() {
return this.skipCheck;
}
/**
*
* 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.
*
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.
*/
public void setRegisterNewBaseline(Boolean registerNewBaseline) {
this.registerNewBaseline = 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.
*
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.
*/
public Boolean getRegisterNewBaseline() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QualityCheckStepMetadata withRegisterNewBaseline(Boolean registerNewBaseline) {
setRegisterNewBaseline(registerNewBaseline);
return this;
}
/**
*
* 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.
*
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.
*/
public Boolean isRegisterNewBaseline() {
return this.registerNewBaseline;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCheckType() != null)
sb.append("CheckType: ").append(getCheckType()).append(",");
if (getBaselineUsedForDriftCheckStatistics() != null)
sb.append("BaselineUsedForDriftCheckStatistics: ").append(getBaselineUsedForDriftCheckStatistics()).append(",");
if (getBaselineUsedForDriftCheckConstraints() != null)
sb.append("BaselineUsedForDriftCheckConstraints: ").append(getBaselineUsedForDriftCheckConstraints()).append(",");
if (getCalculatedBaselineStatistics() != null)
sb.append("CalculatedBaselineStatistics: ").append(getCalculatedBaselineStatistics()).append(",");
if (getCalculatedBaselineConstraints() != null)
sb.append("CalculatedBaselineConstraints: ").append(getCalculatedBaselineConstraints()).append(",");
if (getModelPackageGroupName() != null)
sb.append("ModelPackageGroupName: ").append(getModelPackageGroupName()).append(",");
if (getViolationReport() != null)
sb.append("ViolationReport: ").append(getViolationReport()).append(",");
if (getCheckJobArn() != null)
sb.append("CheckJobArn: ").append(getCheckJobArn()).append(",");
if (getSkipCheck() != null)
sb.append("SkipCheck: ").append(getSkipCheck()).append(",");
if (getRegisterNewBaseline() != null)
sb.append("RegisterNewBaseline: ").append(getRegisterNewBaseline());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof QualityCheckStepMetadata == false)
return false;
QualityCheckStepMetadata other = (QualityCheckStepMetadata) obj;
if (other.getCheckType() == null ^ this.getCheckType() == null)
return false;
if (other.getCheckType() != null && other.getCheckType().equals(this.getCheckType()) == false)
return false;
if (other.getBaselineUsedForDriftCheckStatistics() == null ^ this.getBaselineUsedForDriftCheckStatistics() == null)
return false;
if (other.getBaselineUsedForDriftCheckStatistics() != null
&& other.getBaselineUsedForDriftCheckStatistics().equals(this.getBaselineUsedForDriftCheckStatistics()) == false)
return false;
if (other.getBaselineUsedForDriftCheckConstraints() == null ^ this.getBaselineUsedForDriftCheckConstraints() == null)
return false;
if (other.getBaselineUsedForDriftCheckConstraints() != null
&& other.getBaselineUsedForDriftCheckConstraints().equals(this.getBaselineUsedForDriftCheckConstraints()) == false)
return false;
if (other.getCalculatedBaselineStatistics() == null ^ this.getCalculatedBaselineStatistics() == null)
return false;
if (other.getCalculatedBaselineStatistics() != null && other.getCalculatedBaselineStatistics().equals(this.getCalculatedBaselineStatistics()) == false)
return false;
if (other.getCalculatedBaselineConstraints() == null ^ this.getCalculatedBaselineConstraints() == null)
return false;
if (other.getCalculatedBaselineConstraints() != null
&& other.getCalculatedBaselineConstraints().equals(this.getCalculatedBaselineConstraints()) == false)
return false;
if (other.getModelPackageGroupName() == null ^ this.getModelPackageGroupName() == null)
return false;
if (other.getModelPackageGroupName() != null && other.getModelPackageGroupName().equals(this.getModelPackageGroupName()) == false)
return false;
if (other.getViolationReport() == null ^ this.getViolationReport() == null)
return false;
if (other.getViolationReport() != null && other.getViolationReport().equals(this.getViolationReport()) == false)
return false;
if (other.getCheckJobArn() == null ^ this.getCheckJobArn() == null)
return false;
if (other.getCheckJobArn() != null && other.getCheckJobArn().equals(this.getCheckJobArn()) == false)
return false;
if (other.getSkipCheck() == null ^ this.getSkipCheck() == null)
return false;
if (other.getSkipCheck() != null && other.getSkipCheck().equals(this.getSkipCheck()) == false)
return false;
if (other.getRegisterNewBaseline() == null ^ this.getRegisterNewBaseline() == null)
return false;
if (other.getRegisterNewBaseline() != null && other.getRegisterNewBaseline().equals(this.getRegisterNewBaseline()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCheckType() == null) ? 0 : getCheckType().hashCode());
hashCode = prime * hashCode + ((getBaselineUsedForDriftCheckStatistics() == null) ? 0 : getBaselineUsedForDriftCheckStatistics().hashCode());
hashCode = prime * hashCode + ((getBaselineUsedForDriftCheckConstraints() == null) ? 0 : getBaselineUsedForDriftCheckConstraints().hashCode());
hashCode = prime * hashCode + ((getCalculatedBaselineStatistics() == null) ? 0 : getCalculatedBaselineStatistics().hashCode());
hashCode = prime * hashCode + ((getCalculatedBaselineConstraints() == null) ? 0 : getCalculatedBaselineConstraints().hashCode());
hashCode = prime * hashCode + ((getModelPackageGroupName() == null) ? 0 : getModelPackageGroupName().hashCode());
hashCode = prime * hashCode + ((getViolationReport() == null) ? 0 : getViolationReport().hashCode());
hashCode = prime * hashCode + ((getCheckJobArn() == null) ? 0 : getCheckJobArn().hashCode());
hashCode = prime * hashCode + ((getSkipCheck() == null) ? 0 : getSkipCheck().hashCode());
hashCode = prime * hashCode + ((getRegisterNewBaseline() == null) ? 0 : getRegisterNewBaseline().hashCode());
return hashCode;
}
@Override
public QualityCheckStepMetadata clone() {
try {
return (QualityCheckStepMetadata) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sagemaker.model.transform.QualityCheckStepMetadataMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}