View Source GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScan (google_api_dataplex v0.11.0)

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

Attributes

  • createTime (type: DateTime.t, default: nil) - Output only. The time when the scan was created.
  • data (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataSource.t, default: nil) - Required. The data source for DataScan.
  • dataProfileResult (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataProfileResult.t, default: nil) - Output only. The result of the data profile scan.
  • dataProfileSpec (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataProfileSpec.t, default: nil) - DataProfileScan related setting.
  • dataQualityResult (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityResult.t, default: nil) - Output only. The result of the data quality scan.
  • dataQualitySpec (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualitySpec.t, default: nil) - DataQualityScan related setting.
  • description (type: String.t, default: nil) - Optional. Description of the scan. Must be between 1-1024 characters.
  • displayName (type: String.t, default: nil) - Optional. User friendly display name. Must be between 1-256 characters.
  • executionSpec (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScanExecutionSpec.t, default: nil) - Optional. DataScan execution settings.If not specified, the fields in it will use their default values.
  • executionStatus (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScanExecutionStatus.t, default: nil) - Output only. Status of the data scan execution.
  • labels (type: map(), default: nil) - Optional. User-defined labels for the scan.
  • name (type: String.t, default: nil) - 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.
  • state (type: String.t, default: nil) - Output only. Current state of the DataScan.
  • type (type: String.t, default: nil) - Output only. The type of DataScan.
  • uid (type: String.t, default: nil) - 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.
  • updateTime (type: DateTime.t, default: nil) - Output only. The time when the scan was last updated.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScan{
  createTime: DateTime.t() | nil,
  data: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataSource.t() | nil,
  dataProfileResult:
    GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataProfileResult.t() | nil,
  dataProfileSpec:
    GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataProfileSpec.t() | nil,
  dataQualityResult:
    GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityResult.t() | nil,
  dataQualitySpec:
    GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualitySpec.t() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  executionSpec:
    GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScanExecutionSpec.t()
    | nil,
  executionStatus:
    GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScanExecutionStatus.t()
    | nil,
  labels: map() | nil,
  name: String.t() | nil,
  state: String.t() | nil,
  type: String.t() | nil,
  uid: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.