Class: Google::Cloud::Dataplex::V1::DataQualityResult

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/data_quality.rb

Overview

The output of a DataQualityScan.

Defined Under Namespace

Classes: PostScanActionsResult

Instance Attribute Summary collapse

Instance Attribute Details

#columns ⇒ ::Array<::Google::Cloud::Dataplex::V1::DataQualityColumnResult> (readonly)

Returns Output only. A list of results at the column level.

A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 106

class DataQualityResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The result of post scan actions of DataQualityScan job.
  # @!attribute [r] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult]
  #     Output only. The result of BigQuery export post scan action.
  class PostScanActionsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of BigQuery export post scan action.
    # @!attribute [r] state
    #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult::State]
    #     Output only. Execution state for the BigQuery exporting.
    # @!attribute [r] message
    #   @return [::String]
    #     Output only. Additional information about the BigQuery exporting.
    class BigQueryExportResult
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Execution state for the exporting.
      module State
        # The exporting state is unspecified.
        STATE_UNSPECIFIED = 0

        # The exporting completed successfully.
        SUCCEEDED = 1

        # The exporting is no longer running due to an error.
        FAILED = 2

        # The exporting is skipped due to no valid scan result to export
        # (usually caused by scan failed).
        SKIPPED = 3
      end
    end
  end
end

#dimensions ⇒ ::Array<::Google::Cloud::Dataplex::V1::DataQualityDimensionResult>

Returns A list of results at the dimension level.

A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 106

class DataQualityResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The result of post scan actions of DataQualityScan job.
  # @!attribute [r] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult]
  #     Output only. The result of BigQuery export post scan action.
  class PostScanActionsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of BigQuery export post scan action.
    # @!attribute [r] state
    #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult::State]
    #     Output only. Execution state for the BigQuery exporting.
    # @!attribute [r] message
    #   @return [::String]
    #     Output only. Additional information about the BigQuery exporting.
    class BigQueryExportResult
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Execution state for the exporting.
      module State
        # The exporting state is unspecified.
        STATE_UNSPECIFIED = 0

        # The exporting completed successfully.
        SUCCEEDED = 1

        # The exporting is no longer running due to an error.
        FAILED = 2

        # The exporting is skipped due to no valid scan result to export
        # (usually caused by scan failed).
        SKIPPED = 3
      end
    end
  end
end

#passed ⇒ ::Boolean

Returns Overall data quality result -- true if all rules passed.

Returns:

  • (::Boolean) —

    Overall data quality result -- true if all rules passed.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 106

class DataQualityResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The result of post scan actions of DataQualityScan job.
  # @!attribute [r] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult]
  #     Output only. The result of BigQuery export post scan action.
  class PostScanActionsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of BigQuery export post scan action.
    # @!attribute [r] state
    #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult::State]
    #     Output only. Execution state for the BigQuery exporting.
    # @!attribute [r] message
    #   @return [::String]
    #     Output only. Additional information about the BigQuery exporting.
    class BigQueryExportResult
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Execution state for the exporting.
      module State
        # The exporting state is unspecified.
        STATE_UNSPECIFIED = 0

        # The exporting completed successfully.
        SUCCEEDED = 1

        # The exporting is no longer running due to an error.
        FAILED = 2

        # The exporting is skipped due to no valid scan result to export
        # (usually caused by scan failed).
        SKIPPED = 3
      end
    end
  end
end

#post_scan_actions_result ⇒ ::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult (readonly)

Returns Output only. The result of post scan actions.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 106

class DataQualityResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The result of post scan actions of DataQualityScan job.
  # @!attribute [r] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult]
  #     Output only. The result of BigQuery export post scan action.
  class PostScanActionsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of BigQuery export post scan action.
    # @!attribute [r] state
    #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult::State]
    #     Output only. Execution state for the BigQuery exporting.
    # @!attribute [r] message
    #   @return [::String]
    #     Output only. Additional information about the BigQuery exporting.
    class BigQueryExportResult
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Execution state for the exporting.
      module State
        # The exporting state is unspecified.
        STATE_UNSPECIFIED = 0

        # The exporting completed successfully.
        SUCCEEDED = 1

        # The exporting is no longer running due to an error.
        FAILED = 2

        # The exporting is skipped due to no valid scan result to export
        # (usually caused by scan failed).
        SKIPPED = 3
      end
    end
  end
end

#row_count ⇒ ::Integer

Returns The count of rows processed.

Returns:

  • (::Integer) —

    The count of rows processed.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 106

class DataQualityResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The result of post scan actions of DataQualityScan job.
  # @!attribute [r] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult]
  #     Output only. The result of BigQuery export post scan action.
  class PostScanActionsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of BigQuery export post scan action.
    # @!attribute [r] state
    #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult::State]
    #     Output only. Execution state for the BigQuery exporting.
    # @!attribute [r] message
    #   @return [::String]
    #     Output only. Additional information about the BigQuery exporting.
    class BigQueryExportResult
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Execution state for the exporting.
      module State
        # The exporting state is unspecified.
        STATE_UNSPECIFIED = 0

        # The exporting completed successfully.
        SUCCEEDED = 1

        # The exporting is no longer running due to an error.
        FAILED = 2

        # The exporting is skipped due to no valid scan result to export
        # (usually caused by scan failed).
        SKIPPED = 3
      end
    end
  end
end

#rules ⇒ ::Array<::Google::Cloud::Dataplex::V1::DataQualityRuleResult>

Returns A list of all the rules in a job, and their results.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 106

class DataQualityResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The result of post scan actions of DataQualityScan job.
  # @!attribute [r] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult]
  #     Output only. The result of BigQuery export post scan action.
  class PostScanActionsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of BigQuery export post scan action.
    # @!attribute [r] state
    #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult::State]
    #     Output only. Execution state for the BigQuery exporting.
    # @!attribute [r] message
    #   @return [::String]
    #     Output only. Additional information about the BigQuery exporting.
    class BigQueryExportResult
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Execution state for the exporting.
      module State
        # The exporting state is unspecified.
        STATE_UNSPECIFIED = 0

        # The exporting completed successfully.
        SUCCEEDED = 1

        # The exporting is no longer running due to an error.
        FAILED = 2

        # The exporting is skipped due to no valid scan result to export
        # (usually caused by scan failed).
        SKIPPED = 3
      end
    end
  end
end

#scanned_data ⇒ ::Google::Cloud::Dataplex::V1::ScannedData

Returns The data scanned for this result.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 106

class DataQualityResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The result of post scan actions of DataQualityScan job.
  # @!attribute [r] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult]
  #     Output only. The result of BigQuery export post scan action.
  class PostScanActionsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of BigQuery export post scan action.
    # @!attribute [r] state
    #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult::State]
    #     Output only. Execution state for the BigQuery exporting.
    # @!attribute [r] message
    #   @return [::String]
    #     Output only. Additional information about the BigQuery exporting.
    class BigQueryExportResult
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Execution state for the exporting.
      module State
        # The exporting state is unspecified.
        STATE_UNSPECIFIED = 0

        # The exporting completed successfully.
        SUCCEEDED = 1

        # The exporting is no longer running due to an error.
        FAILED = 2

        # The exporting is skipped due to no valid scan result to export
        # (usually caused by scan failed).
        SKIPPED = 3
      end
    end
  end
end

#score ⇒ ::Float (readonly)

Returns Output only. The overall data quality score.

The score ranges between 0, 100.

Returns:

  • (::Float) —

    Output only. The overall data quality score.

    The score ranges between 0, 100.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 106

class DataQualityResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The result of post scan actions of DataQualityScan job.
  # @!attribute [r] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult]
  #     Output only. The result of BigQuery export post scan action.
  class PostScanActionsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of BigQuery export post scan action.
    # @!attribute [r] state
    #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult::BigQueryExportResult::State]
    #     Output only. Execution state for the BigQuery exporting.
    # @!attribute [r] message
    #   @return [::String]
    #     Output only. Additional information about the BigQuery exporting.
    class BigQueryExportResult
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Execution state for the exporting.
      module State
        # The exporting state is unspecified.
        STATE_UNSPECIFIED = 0

        # The exporting completed successfully.
        SUCCEEDED = 1

        # The exporting is no longer running due to an error.
        FAILED = 2

        # The exporting is skipped due to no valid scan result to export
        # (usually caused by scan failed).
        SKIPPED = 3
      end
    end
  end
end