Class: Google::Cloud::Dataplex::V1::DataScanEvent

Inherits:

Object

• Object
• Google::Cloud::Dataplex::V1::DataScanEvent

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dataplex/v1/logs.rb

Overview

These messages contain information about the execution of a datascan. The monitored resource is 'DataScan' Next ID: 13

Defined Under Namespace

Modules: ScanType, Scope, State, Trigger Classes: DataProfileAppliedConfigs, DataProfileResult, DataQualityAppliedConfigs, DataQualityResult, PostScanActionsResult

Instance Attribute Summary

• #create_time ⇒ ::Google::Protobuf::Timestamp

  The time when the data scan job was created.

• #data_profile ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult

  Data profile result for data profile type data scan.

• #data_profile_configs ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileAppliedConfigs

  Applied configs for data profile type data scan.

• #data_quality ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult

  Data quality result for data quality type data scan.

• #data_quality_configs ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityAppliedConfigs

  Applied configs for data quality type data scan.

• #data_source ⇒ ::String

  The data source of the data scan.

• #end_time ⇒ ::Google::Protobuf::Timestamp

  The time when the data scan job finished.

• #job_id ⇒ ::String

  The identifier of the specific data scan job this log entry is for.

• #message ⇒ ::String

  The message describing the data scan job event.

• #post_scan_actions_result ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult

  The result of post scan actions.

• #scope ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::Scope

  The scope of the data scan (e.g. full, incremental).

• #spec_version ⇒ ::String

  A version identifier of the spec which was used to execute this job.

• #start_time ⇒ ::Google::Protobuf::Timestamp

  The time when the data scan job started to run.

• #state ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::State

  The status of the data scan job.

• #trigger ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger

  The trigger type of the data scan job.

• #type ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType

  The type of the data scan.

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the data scan job was created.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time when the data scan job was created.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#data_profile ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult

Returns Data profile result for data profile type data scan.

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult) —

  Data profile result for data profile type data scan.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#data_profile_configs ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileAppliedConfigs

Returns Applied configs for data profile type data scan.

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileAppliedConfigs) —

  Applied configs for data profile type data scan.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#data_quality ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult

Returns Data quality result for data quality type data scan.

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult) —

  Data quality result for data quality type data scan.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#data_quality_configs ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityAppliedConfigs

Returns Applied configs for data quality type data scan.

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityAppliedConfigs) —

  Applied configs for data quality type data scan.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#data_source ⇒ ::String

Returns The data source of the data scan.

Returns:

• (::String) —

  The data source of the data scan

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the data scan job finished.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time when the data scan job finished.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#job_id ⇒ ::String

Returns The identifier of the specific data scan job this log entry is for.

Returns:

• (::String) —

  The identifier of the specific data scan job this log entry is for.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#message ⇒ ::String

Returns The message describing the data scan job event.

Returns:

• (::String) —

  The message describing the data scan job event.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#post_scan_actions_result ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult

Returns The result of post scan actions.

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult) —

  The result of post scan actions.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#scope ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::Scope

Returns The scope of the data scan (e.g. full, incremental).

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::Scope) —

  The scope of the data scan (e.g. full, incremental).

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#spec_version ⇒ ::String

Returns A version identifier of the spec which was used to execute this job.

Returns:

• (::String) —

  A version identifier of the spec which was used to execute this job.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the data scan job started to run.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time when the data scan job started to run.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#state ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::State

Returns The status of the data scan job.

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::State) —

  The status of the data scan job.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#trigger ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger

Returns The trigger type of the data scan job.

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger) —

  The trigger type of the data scan job.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end

#type ⇒ ::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType

Returns The type of the data scan.

Returns:

• (::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType) —

  The type of the data scan.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 392

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

  # Data profile result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  class DataProfileResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Data quality result for data scan job.
  # @!attribute [rw] row_count
  #   @return [::Integer]
  #     The count of rows processed in the data scan job.
  # @!attribute [rw] passed
  #   @return [::Boolean]
  #     Whether the data quality result was `pass` or not.
  # @!attribute [rw] dimension_passed
  #   @return [::Google::Protobuf::Map{::String => ::Boolean}]
  #     The result of each dimension for data quality result.
  #     The key of the map is the name of the dimension.
  #     The value is the bool value depicting whether the dimension result was
  #     `pass` or not.
  class DataQualityResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Boolean]
    class DimensionPassedEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Applied configs for data profile type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  # @!attribute [rw] column_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a column filter was applied in the DataScan
  #     job.
  class DataProfileAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Applied configs for data quality type data scan job.
  # @!attribute [rw] sampling_percent
  #   @return [::Float]
  #     The percentage of the records selected from the dataset for DataScan.
  #
  #     * Value ranges between 0.0 and 100.0.
  #     * Value 0.0 or 100.0 imply that sampling was not applied.
  # @!attribute [rw] row_filter_applied
  #   @return [::Boolean]
  #     Boolean indicating whether a row filter was applied in the DataScan job.
  class DataQualityAppliedConfigs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Post scan actions result for data scan job.
  # @!attribute [rw] bigquery_export_result
  #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult]
  #     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 [rw] state
    #   @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult::BigQueryExportResult::State]
    #     Execution state for the BigQuery exporting.
    # @!attribute [rw] message
    #   @return [::String]
    #     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

  # The type of the data scan.
  module ScanType
    # An unspecified data scan type.
    SCAN_TYPE_UNSPECIFIED = 0

    # Data scan for data profile.
    DATA_PROFILE = 1

    # Data scan for data quality.
    DATA_QUALITY = 2
  end

  # The job state of the data scan.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Data scan job started.
    STARTED = 1

    # Data scan job successfully completed.
    SUCCEEDED = 2

    # Data scan job was unsuccessful.
    FAILED = 3

    # Data scan job was cancelled.
    CANCELLED = 4

    # Data scan job was createed.
    CREATED = 5
  end

  # The trigger type for the data scan.
  module Trigger
    # An unspecified trigger type.
    TRIGGER_UNSPECIFIED = 0

    # Data scan triggers on demand.
    ON_DEMAND = 1

    # Data scan triggers as per schedule.
    SCHEDULE = 2
  end

  # The scope of job for the data scan.
  module Scope
    # An unspecified scope type.
    SCOPE_UNSPECIFIED = 0

    # Data scan runs on all of the data.
    FULL = 1

    # Data scan runs on incremental data.
    INCREMENTAL = 2
  end
end