Class: Aws::Glue::Types::DataQualityResult

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::DataQualityResult

Includes:

Structure

Defined in:

lib/aws-sdk-glue/types.rb

Overview

Describes a data quality result.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #analyzer_results ⇒ Array<Types::DataQualityAnalyzerResult>

  A list of ‘DataQualityAnalyzerResult` objects representing the results for each analyzer.

• #completed_on ⇒ Time

  The date and time when this data quality run completed.

• #data_source ⇒ Types::DataSource

  The table associated with the data quality result, if any.

• #evaluation_context ⇒ String

  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.

• #job_name ⇒ String

  The job name associated with the data quality result, if any.

• #job_run_id ⇒ String

  The job run ID associated with the data quality result, if any.

• #observations ⇒ Array<Types::DataQualityObservation>

  A list of ‘DataQualityObservation` objects representing the observations generated after evaluating the rules and analyzers.

• #profile_id ⇒ String

  The Profile ID for the data quality result.

• #result_id ⇒ String

  A unique result ID for the data quality result.

• #rule_results ⇒ Array<Types::DataQualityRuleResult>

  A list of ‘DataQualityRuleResult` objects representing the results for each rule.

• #ruleset_evaluation_run_id ⇒ String

  The unique run ID for the ruleset evaluation for this data quality result.

• #ruleset_name ⇒ String

  The name of the ruleset associated with the data quality result.

• #score ⇒ Float

  An aggregate data quality score.

• #started_on ⇒ Time

  The date and time when this data quality run started.

Instance Attribute Details

#analyzer_results ⇒ Array<Types::DataQualityAnalyzerResult>

A list of ‘DataQualityAnalyzerResult` objects representing the results for each analyzer.

Returns:

• (Array<Types::DataQualityAnalyzerResult>)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#completed_on ⇒ Time

The date and time when this data quality run completed.

Returns:

• (Time)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#data_source ⇒ Types::DataSource

The table associated with the data quality result, if any.

Returns:

• (Types::DataSource)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_context ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The job name associated with the data quality result, if any.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#job_run_id ⇒ String

The job run ID associated with the data quality result, if any.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#observations ⇒ Array<Types::DataQualityObservation>

A list of ‘DataQualityObservation` objects representing the observations generated after evaluating the rules and analyzers.

Returns:

• (Array<Types::DataQualityObservation>)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#profile_id ⇒ String

The Profile ID for the data quality result.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#result_id ⇒ String

A unique result ID for the data quality result.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#rule_results ⇒ Array<Types::DataQualityRuleResult>

A list of ‘DataQualityRuleResult` objects representing the results for each rule.

Returns:

• (Array<Types::DataQualityRuleResult>)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#ruleset_evaluation_run_id ⇒ String

The unique run ID for the ruleset evaluation for this data quality result.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#ruleset_name ⇒ String

The name of the ruleset associated with the data quality result.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#score ⇒ Float

An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.

Returns:

• (Float)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end

#started_on ⇒ Time

The date and time when this data quality run started.

Returns:

• (Time)

# File 'lib/aws-sdk-glue/types.rb', line 6723

class DataQualityResult < Struct.new(
  :result_id,
  :profile_id,
  :score,
  :data_source,
  :ruleset_name,
  :evaluation_context,
  :started_on,
  :completed_on,
  :job_name,
  :job_run_id,
  :ruleset_evaluation_run_id,
  :rule_results,
  :analyzer_results,
  :observations)
  SENSITIVE = []
  include Aws::Structure
end