/* * 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.glue.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Describes a data quality result. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DataQualityResult implements Serializable, Cloneable, StructuredPojo { /** ** A unique result ID for the data quality result. *
*/ private String resultId; /** ** An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules. *
*/ private Double score; /** ** The table associated with the data quality result, if any. *
*/ private DataSource dataSource; /** ** The name of the ruleset associated with the data quality result. *
*/ private String rulesetName; /** *
* In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data
* quality nodes will have names. In the case of multiple nodes, the evaluationContext
can
* differentiate the nodes.
*
* The date and time when this data quality run started. *
*/ private java.util.Date startedOn; /** ** The date and time when this data quality run completed. *
*/ private java.util.Date completedOn; /** ** The job name associated with the data quality result, if any. *
*/ private String jobName; /** ** The job run ID associated with the data quality result, if any. *
*/ private String jobRunId; /** ** The unique run ID for the ruleset evaluation for this data quality result. *
*/ private String rulesetEvaluationRunId; /** *
* A list of DataQualityRuleResult
objects representing the results for each rule.
*
* A unique result ID for the data quality result. *
* * @param resultId * A unique result ID for the data quality result. */ public void setResultId(String resultId) { this.resultId = resultId; } /** ** A unique result ID for the data quality result. *
* * @return A unique result ID for the data quality result. */ public String getResultId() { return this.resultId; } /** ** A unique result ID for the data quality result. *
* * @param resultId * A unique result ID for the data quality result. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withResultId(String resultId) { setResultId(resultId); return this; } /** ** An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules. *
* * @param score * An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules. */ public void setScore(Double score) { this.score = score; } /** ** An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules. *
* * @return An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules. */ public Double getScore() { return this.score; } /** ** An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules. *
* * @param score * An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withScore(Double score) { setScore(score); return this; } /** ** The table associated with the data quality result, if any. *
* * @param dataSource * The table associated with the data quality result, if any. */ public void setDataSource(DataSource dataSource) { this.dataSource = dataSource; } /** ** The table associated with the data quality result, if any. *
* * @return The table associated with the data quality result, if any. */ public DataSource getDataSource() { return this.dataSource; } /** ** The table associated with the data quality result, if any. *
* * @param dataSource * The table associated with the data quality result, if any. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withDataSource(DataSource dataSource) { setDataSource(dataSource); return this; } /** ** The name of the ruleset associated with the data quality result. *
* * @param rulesetName * The name of the ruleset associated with the data quality result. */ public void setRulesetName(String rulesetName) { this.rulesetName = rulesetName; } /** ** The name of the ruleset associated with the data quality result. *
* * @return The name of the ruleset associated with the data quality result. */ public String getRulesetName() { return this.rulesetName; } /** ** The name of the ruleset associated with the data quality result. *
* * @param rulesetName * The name of the ruleset associated with the data quality result. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withRulesetName(String rulesetName) { setRulesetName(rulesetName); return this; } /** *
* In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data
* quality nodes will have names. In the case of multiple nodes, the evaluationContext
can
* differentiate the nodes.
*
evaluationContext
* can differentiate the nodes.
*/
public void setEvaluationContext(String evaluationContext) {
this.evaluationContext = evaluationContext;
}
/**
*
* In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data
* quality nodes will have names. In the case of multiple nodes, the evaluationContext
can
* differentiate the nodes.
*
evaluationContext
* can differentiate the nodes.
*/
public String getEvaluationContext() {
return this.evaluationContext;
}
/**
*
* In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data
* quality nodes will have names. In the case of multiple nodes, the evaluationContext
can
* differentiate the nodes.
*
evaluationContext
* can differentiate the nodes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataQualityResult withEvaluationContext(String evaluationContext) {
setEvaluationContext(evaluationContext);
return this;
}
/**
* * The date and time when this data quality run started. *
* * @param startedOn * The date and time when this data quality run started. */ public void setStartedOn(java.util.Date startedOn) { this.startedOn = startedOn; } /** ** The date and time when this data quality run started. *
* * @return The date and time when this data quality run started. */ public java.util.Date getStartedOn() { return this.startedOn; } /** ** The date and time when this data quality run started. *
* * @param startedOn * The date and time when this data quality run started. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withStartedOn(java.util.Date startedOn) { setStartedOn(startedOn); return this; } /** ** The date and time when this data quality run completed. *
* * @param completedOn * The date and time when this data quality run completed. */ public void setCompletedOn(java.util.Date completedOn) { this.completedOn = completedOn; } /** ** The date and time when this data quality run completed. *
* * @return The date and time when this data quality run completed. */ public java.util.Date getCompletedOn() { return this.completedOn; } /** ** The date and time when this data quality run completed. *
* * @param completedOn * The date and time when this data quality run completed. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withCompletedOn(java.util.Date completedOn) { setCompletedOn(completedOn); return this; } /** ** The job name associated with the data quality result, if any. *
* * @param jobName * The job name associated with the data quality result, if any. */ public void setJobName(String jobName) { this.jobName = jobName; } /** ** The job name associated with the data quality result, if any. *
* * @return The job name associated with the data quality result, if any. */ public String getJobName() { return this.jobName; } /** ** The job name associated with the data quality result, if any. *
* * @param jobName * The job name associated with the data quality result, if any. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withJobName(String jobName) { setJobName(jobName); return this; } /** ** The job run ID associated with the data quality result, if any. *
* * @param jobRunId * The job run ID associated with the data quality result, if any. */ public void setJobRunId(String jobRunId) { this.jobRunId = jobRunId; } /** ** The job run ID associated with the data quality result, if any. *
* * @return The job run ID associated with the data quality result, if any. */ public String getJobRunId() { return this.jobRunId; } /** ** The job run ID associated with the data quality result, if any. *
* * @param jobRunId * The job run ID associated with the data quality result, if any. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withJobRunId(String jobRunId) { setJobRunId(jobRunId); return this; } /** ** The unique run ID for the ruleset evaluation for this data quality result. *
* * @param rulesetEvaluationRunId * The unique run ID for the ruleset evaluation for this data quality result. */ public void setRulesetEvaluationRunId(String rulesetEvaluationRunId) { this.rulesetEvaluationRunId = rulesetEvaluationRunId; } /** ** The unique run ID for the ruleset evaluation for this data quality result. *
* * @return The unique run ID for the ruleset evaluation for this data quality result. */ public String getRulesetEvaluationRunId() { return this.rulesetEvaluationRunId; } /** ** The unique run ID for the ruleset evaluation for this data quality result. *
* * @param rulesetEvaluationRunId * The unique run ID for the ruleset evaluation for this data quality result. * @return Returns a reference to this object so that method calls can be chained together. */ public DataQualityResult withRulesetEvaluationRunId(String rulesetEvaluationRunId) { setRulesetEvaluationRunId(rulesetEvaluationRunId); return this; } /** *
* A list of DataQualityRuleResult
objects representing the results for each rule.
*
DataQualityRuleResult
objects representing the results for each rule.
*/
public java.util.List
* A list of DataQualityRuleResult
objects representing the results for each rule.
*
DataQualityRuleResult
objects representing the results for each rule.
*/
public void setRuleResults(java.util.Collection
* A list of DataQualityRuleResult
objects representing the results for each rule.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setRuleResults(java.util.Collection)} or {@link #withRuleResults(java.util.Collection)} if you want to * override the existing values. *
* * @param ruleResults * A list ofDataQualityRuleResult
objects representing the results for each rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataQualityResult withRuleResults(DataQualityRuleResult... ruleResults) {
if (this.ruleResults == null) {
setRuleResults(new java.util.ArrayList
* A list of DataQualityRuleResult
objects representing the results for each rule.
*
DataQualityRuleResult
objects representing the results for each rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataQualityResult withRuleResults(java.util.Collection