Class DataScan (2.3.0)

Version 2.3.0

• 2.3.1 (latest)
• 2.3.0
• 2.2.2
• 2.1.0
• 2.0.1
• 1.13.0
• 1.12.3
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.1
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.1
• 0.2.1
• 0.1.0

DataScan(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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).

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
name	str Output only. 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.
uid	str 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.
description	str Optional. Description of the scan. - Must be between 1-1024 characters.
display_name	str Optional. User friendly display name. - Must be between 1-256 characters.
labels	MutableMapping[str, str] Optional. User-defined labels for the scan.
state	google.cloud.dataplex_v1.types.State Output only. Current state of the DataScan.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. The time when the scan was created.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. The time when the scan was last updated.
data	google.cloud.dataplex_v1.types.DataSource Required. The data source for DataScan.
execution_spec	google.cloud.dataplex_v1.types.DataScan.ExecutionSpec Optional. DataScan execution settings. If not specified, the fields in it will use their default values.
execution_status	google.cloud.dataplex_v1.types.DataScan.ExecutionStatus Output only. Status of the data scan execution.
type_	google.cloud.dataplex_v1.types.DataScanType Output only. The type of DataScan.
data_quality_spec	google.cloud.dataplex_v1.types.DataQualitySpec DataQualityScan related setting. This field is a member of oneof_ spec.
data_profile_spec	google.cloud.dataplex_v1.types.DataProfileSpec DataProfileScan related setting. This field is a member of oneof_ spec.
data_quality_result	google.cloud.dataplex_v1.types.DataQualityResult Output only. The result of the data quality scan. This field is a member of oneof_ result.
data_profile_result	google.cloud.dataplex_v1.types.DataProfileResult Output only. The result of the data profile scan. This field is a member of oneof_ result.

Classes

ExecutionSpec

ExecutionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

DataScan execution settings.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExecutionStatus

ExecutionStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Status of the data scan execution.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.