Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataScan (v2.10.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. For more information, see Auto data quality overview.
  • Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling.
  • Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data.
  • Data documentation: analyzes the table or dataset metadata and generates insights. For tables, insights include descriptions and sample SQL queries. For datasets, insights include descriptions, schema relationships and sample SQL queries. For more information, see Generate data insights in BigQuery.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

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

#data

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

#data=

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

#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, data_documentation_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, data_documentation_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, data_documentation_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, data_documentation_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_documentation_result

def data_documentation_result() -> ::Google::Cloud::Dataplex::V1::DataDocumentationResult
Returns
  • (::Google::Cloud::Dataplex::V1::DataDocumentationResult) — Output only. The result of a data documentation scan.

    Note: The following fields are mutually exclusive: data_documentation_result, 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_documentation_spec

def data_documentation_spec() -> ::Google::Cloud::Dataplex::V1::DataDocumentationSpec
Returns
  • (::Google::Cloud::Dataplex::V1::DataDocumentationSpec) — Settings for a data documentation scan.

    Note: The following fields are mutually exclusive: data_documentation_spec, 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_documentation_spec=

def data_documentation_spec=(value) -> ::Google::Cloud::Dataplex::V1::DataDocumentationSpec
Parameter
  • value (::Google::Cloud::Dataplex::V1::DataDocumentationSpec) — Settings for a data documentation scan.

    Note: The following fields are mutually exclusive: data_documentation_spec, 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::DataDocumentationSpec) — Settings for a data documentation scan.

    Note: The following fields are mutually exclusive: data_documentation_spec, 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_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, data_documentation_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, data_documentation_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, data_documentation_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, data_documentation_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, data_documentation_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, data_documentation_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, data_documentation_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, data_documentation_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_identity

def execution_identity() -> ::Google::Cloud::Dataplex::V1::ExecutionIdentity
Returns

#execution_identity=

def execution_identity=(value) -> ::Google::Cloud::Dataplex::V1::ExecutionIdentity
Parameter
Returns

#execution_spec

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

#execution_spec=

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

#execution_status

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

#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 Google Cloud region.

#state

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

#type

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

#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