Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataScanEvent (v1.4.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataScanEvent.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — The time when the data scan job was created.

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — The time when the data scan job was created.

Returns

(::Google::Protobuf::Timestamp) — The time when the data scan job was created.

#data_profile

def data_profile() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult) — Data profile result for data profile type data scan.

Note: The following fields are mutually exclusive: data_profile, data_quality. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_profile=

def data_profile=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult) — Data profile result for data profile type data scan.

Note: The following fields are mutually exclusive: data_profile, data_quality. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult) — Data profile result for data profile type data scan.

Note: The following fields are mutually exclusive: data_profile, data_quality. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_profile_configs

def data_profile_configs() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileAppliedConfigs

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileAppliedConfigs) — Applied configs for data profile type data scan.

Note: The following fields are mutually exclusive: data_profile_configs, data_quality_configs. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_profile_configs=

def data_profile_configs=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileAppliedConfigs

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileAppliedConfigs) — Applied configs for data profile type data scan.

Note: The following fields are mutually exclusive: data_profile_configs, data_quality_configs. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileAppliedConfigs) — Applied configs for data profile type data scan.

Note: The following fields are mutually exclusive: data_profile_configs, data_quality_configs. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_quality

def data_quality() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult) — Data quality result for data quality type data scan.

Note: The following fields are mutually exclusive: data_quality, data_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_quality=

def data_quality=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult) — Data quality result for data quality type data scan.

Note: The following fields are mutually exclusive: data_quality, data_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult) — Data quality result for data quality type data scan.

Note: The following fields are mutually exclusive: data_quality, data_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_quality_configs

def data_quality_configs() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityAppliedConfigs

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityAppliedConfigs) — Applied configs for data quality type data scan.

Note: The following fields are mutually exclusive: data_quality_configs, data_profile_configs. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_quality_configs=

def data_quality_configs=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityAppliedConfigs

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityAppliedConfigs) — Applied configs for data quality type data scan.

Note: The following fields are mutually exclusive: data_quality_configs, data_profile_configs. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityAppliedConfigs) — Applied configs for data quality type data scan.

Note: The following fields are mutually exclusive: data_quality_configs, data_profile_configs. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_source

def data_source() -> ::String

Returns

(::String) — The data source of the data scan

#data_source=

def data_source=(value) -> ::String

Parameter

value (::String) — The data source of the data scan

Returns

(::String) — The data source of the data scan

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — The time when the data scan job finished.

#end_time=

def end_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — The time when the data scan job finished.

Returns

(::Google::Protobuf::Timestamp) — The time when the data scan job finished.

#job_id

def job_id() -> ::String

Returns

(::String) — The identifier of the specific data scan job this log entry is for.

#job_id=

def job_id=(value) -> ::String

Parameter

value (::String) — 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.

#message

def message() -> ::String

Returns

(::String) — The message describing the data scan job event.

#message=

def message=(value) -> ::String

Parameter

value (::String) — The message describing the data scan job event.

Returns

(::String) — The message describing the data scan job event.

#post_scan_actions_result

def post_scan_actions_result() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult) — The result of post scan actions.

#post_scan_actions_result=

def post_scan_actions_result=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult) — The result of post scan actions.

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult) — The result of post scan actions.

#scope

def scope() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::Scope

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::Scope) — The scope of the data scan (e.g. full, incremental).

#scope=

def scope=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::Scope

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::Scope) — 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).

#spec_version

def spec_version() -> ::String

Returns

(::String) — A version identifier of the spec which was used to execute this job.

#spec_version=

def spec_version=(value) -> ::String

Parameter

value (::String) — 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.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — The time when the data scan job started to run.

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — The time when the data scan job started to run.

Returns

(::Google::Protobuf::Timestamp) — The time when the data scan job started to run.

#state

def state() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::State

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::State) — The status of the data scan job.

#state=

def state=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::State

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::State) — The status of the data scan job.

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::State) — The status of the data scan job.

#trigger

def trigger() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger) — The trigger type of the data scan job.

#trigger=

def trigger=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger) — The trigger type of the data scan job.

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger) — The trigger type of the data scan job.

#type

def type() -> ::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType) — The type of the data scan.

#type=

def type=(value) -> ::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType

Parameter

value (::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType) — The type of the data scan.

Returns

(::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType) — The type of the data scan.