Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataScan (v2.0.0)

Version 2.0.0

• 2.1.0 (latest)
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.1
• 0.23.0
• 0.22.0
• 0.21.1
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.1
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.0

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

Represents a user-visible job which provides the insights for the related data source.

For example:

• Data Quality: generates queries based on the rules and runs against the data to get data quality check results.
• Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).

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) — Output only. The time when the scan was created.

#data

def data() -> ::Google::Cloud::Dataplex::V1::DataSource

Returns

• (::Google::Cloud::Dataplex::V1::DataSource) — Required. The data source for DataScan.

#data=

def data=(value) -> ::Google::Cloud::Dataplex::V1::DataSource

Parameter

• value (::Google::Cloud::Dataplex::V1::DataSource) — Required. The data source for DataScan.

Returns

• (::Google::Cloud::Dataplex::V1::DataSource) — Required. The data source for DataScan.

#data_discovery_result

def data_discovery_result() -> ::Google::Cloud::Dataplex::V1::DataDiscoveryResult

Returns

• (::Google::Cloud::Dataplex::V1::DataDiscoveryResult) — Output only. The result of a data discovery scan.

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

#data_discovery_spec

def data_discovery_spec() -> ::Google::Cloud::Dataplex::V1::DataDiscoverySpec

Returns

• (::Google::Cloud::Dataplex::V1::DataDiscoverySpec) — Settings for a data discovery scan.

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

#data_discovery_spec=

def data_discovery_spec=(value) -> ::Google::Cloud::Dataplex::V1::DataDiscoverySpec

Parameter

• value (::Google::Cloud::Dataplex::V1::DataDiscoverySpec) — Settings for a data discovery scan.

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

Returns

• (::Google::Cloud::Dataplex::V1::DataDiscoverySpec) — Settings for a data discovery scan.

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

#data_profile_result

def data_profile_result() -> ::Google::Cloud::Dataplex::V1::DataProfileResult

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileResult) — Output only. The result of a data profile scan.

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

#data_profile_spec

def data_profile_spec() -> ::Google::Cloud::Dataplex::V1::DataProfileSpec

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileSpec) — Settings for a data profile scan.

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

#data_profile_spec=

def data_profile_spec=(value) -> ::Google::Cloud::Dataplex::V1::DataProfileSpec

Parameter

• value (::Google::Cloud::Dataplex::V1::DataProfileSpec) — Settings for a data profile scan.

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

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileSpec) — Settings for a data profile scan.

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

#data_quality_result

def data_quality_result() -> ::Google::Cloud::Dataplex::V1::DataQualityResult

Returns

• (::Google::Cloud::Dataplex::V1::DataQualityResult) — Output only. The result of a data quality scan.

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

#data_quality_spec

def data_quality_spec() -> ::Google::Cloud::Dataplex::V1::DataQualitySpec

Returns

• (::Google::Cloud::Dataplex::V1::DataQualitySpec) — Settings for a data quality scan.

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

#data_quality_spec=

def data_quality_spec=(value) -> ::Google::Cloud::Dataplex::V1::DataQualitySpec

Parameter

• value (::Google::Cloud::Dataplex::V1::DataQualitySpec) — Settings for a data quality scan.

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

Returns

• (::Google::Cloud::Dataplex::V1::DataQualitySpec) — Settings for a data quality scan.

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

#description

def description() -> ::String

Returns

• (::String) —

  Optional. Description of the scan.

  • Must be between 1-1024 characters.

#description=

def description=(value) -> ::String

Parameter

• value (::String) —

  Optional. Description of the scan.

  • Must be between 1-1024 characters.

Returns

• (::String) —

  Optional. Description of the scan.

  • Must be between 1-1024 characters.

#display_name

def display_name() -> ::String

Returns

• (::String) —

  Optional. User friendly display name.

  • Must be between 1-256 characters.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) —

  Optional. User friendly display name.

  • Must be between 1-256 characters.

Returns

• (::String) —

  Optional. User friendly display name.

  • Must be between 1-256 characters.

#execution_spec

def execution_spec() -> ::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec

Returns

• (::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec) — Optional. DataScan execution settings.

  If not specified, the fields in it will use their default values.

#execution_spec=

def execution_spec=(value) -> ::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec

Parameter

• value (::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec) — Optional. DataScan execution settings.

  If not specified, the fields in it will use their default values.

Returns

• (::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec) — Optional. DataScan execution settings.

  If not specified, the fields in it will use their default values.

#execution_status

def execution_status() -> ::Google::Cloud::Dataplex::V1::DataScan::ExecutionStatus

Returns

• (::Google::Cloud::Dataplex::V1::DataScan::ExecutionStatus) — Output only. Status of the data scan execution.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the scan.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the scan.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the scan.

#name

def name() -> ::String

Returns

• (::String) — Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

#state

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

Returns

• (::Google::Cloud::Dataplex::V1::State) — Output only. Current state of the DataScan.

#type

def type() -> ::Google::Cloud::Dataplex::V1::DataScanType

Returns

• (::Google::Cloud::Dataplex::V1::DataScanType) — Output only. The type of DataScan.

#uid

def uid() -> ::String

Returns

• (::String) — Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.

#update_time

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

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time when the scan was last updated.