Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1DataScan

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb

Overview

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 (https://cloud.google.com/dataplex/docs/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 (https://cloud.google.com/dataplex/docs/data-profiling-overview) . Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). 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 (https://cloud. google.com/bigquery/docs/data-insights).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1DataScan

Returns a new instance of GoogleCloudDataplexV1DataScan.



5154
5155
5156
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5154

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. The time when the scan was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


5037
5038
5039
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5037

def create_time
  @create_time
end

#data ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataSource

The data source for DataScan. Corresponds to the JSON property data

Returns:



5042
5043
5044
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5042

def data
  @data
end

#data_discovery_result ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDiscoveryResult

The output of a data discovery scan. Corresponds to the JSON property dataDiscoveryResult

Returns:



5047
5048
5049
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5047

def data_discovery_result
  @data_discovery_result
end

#data_discovery_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDiscoverySpec

Spec for a data discovery scan. Corresponds to the JSON property dataDiscoverySpec

Returns:



5052
5053
5054
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5052

def data_discovery_spec
  @data_discovery_spec
end

#data_documentation_result ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDocumentationResult

The output of a DataDocumentation scan. Corresponds to the JSON property dataDocumentationResult

Returns:



5057
5058
5059
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5057

def data_documentation_result
  @data_documentation_result
end

#data_documentation_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDocumentationSpec

DataDocumentation scan related spec. Corresponds to the JSON property dataDocumentationSpec

Returns:



5062
5063
5064
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5062

def data_documentation_spec
  @data_documentation_spec
end

#data_profile_result ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResult

DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. Corresponds to the JSON property dataProfileResult

Returns:



5068
5069
5070
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5068

def data_profile_result
  @data_profile_result
end

#data_profile_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileSpec

DataProfileScan related setting. Corresponds to the JSON property dataProfileSpec

Returns:



5073
5074
5075
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5073

def data_profile_spec
  @data_profile_spec
end

#data_quality_result ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityResult

The output of a DataQualityScan. Corresponds to the JSON property dataQualityResult

Returns:



5078
5079
5080
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5078

def data_quality_result
  @data_quality_result
end

#data_quality_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualitySpec

DataQualityScan related setting. Corresponds to the JSON property dataQualitySpec

Returns:



5083
5084
5085
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5083

def data_quality_spec
  @data_quality_spec
end

#description ⇒ String

Optional. Description of the scan. Must be between 1-1024 characters. Corresponds to the JSON property description

Returns:

  • (String) 


5088
5089
5090
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5088

def description
  @description
end

#display_name ⇒ String

Optional. User friendly display name. Must be between 1-256 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


5093
5094
5095
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5093

def display_name
  @display_name
end

#execution_identity ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1ExecutionIdentity

The identity to run the datascan. Corresponds to the JSON property executionIdentity

Returns:



5098
5099
5100
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5098

def execution_identity
  @execution_identity
end

#execution_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataScanExecutionSpec

DataScan execution settings. Corresponds to the JSON property executionSpec

Returns:



5103
5104
5105
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5103

def execution_spec
  @execution_spec
end

#execution_status ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataScanExecutionStatus

Status of the data scan execution. Corresponds to the JSON property executionStatus

Returns:



5108
5109
5110
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5108

def execution_status
  @execution_status
end

#labels ⇒ Hash<String,String>

Optional. User-defined labels for the scan. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


5113
5114
5115
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5113

def labels
  @labels
end

#name ⇒ 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. Corresponds to the JSON property name

Returns:

  • (String) 


5121
5122
5123
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5121

def name
  @name
end

#state ⇒ String

Output only. Current state of the DataScan. Corresponds to the JSON property state

Returns:

  • (String) 


5126
5127
5128
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5126

def state
  @state
end

#type ⇒ String

Output only. The type of DataScan. Corresponds to the JSON property type

Returns:

  • (String) 


5131
5132
5133
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5131

def type
  @type
end

#uid ⇒ 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. Corresponds to the JSON property uid

Returns:

  • (String) 


5137
5138
5139
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5137

def uid
  @uid
end

#unstructured_data_profile_result ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1UnstructuredDataProfileResult

Contains the result of an unstructured data profile scan. Corresponds to the JSON property unstructuredDataProfileResult

Returns:



5142
5143
5144
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5142

def unstructured_data_profile_result
  @unstructured_data_profile_result
end

#unstructured_data_profile_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1UnstructuredDataProfileSpec

Contains the specification for an unstructured data profile scan. Corresponds to the JSON property unstructuredDataProfileSpec

Returns:



5147
5148
5149
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5147

def unstructured_data_profile_spec
  @unstructured_data_profile_spec
end

#update_time ⇒ String

Output only. The time when the scan was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5152
5153
5154
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5152

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5159

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data = args[:data] if args.key?(:data)
  @data_discovery_result = args[:data_discovery_result] if args.key?(:data_discovery_result)
  @data_discovery_spec = args[:data_discovery_spec] if args.key?(:data_discovery_spec)
  @data_documentation_result = args[:data_documentation_result] if args.key?(:data_documentation_result)
  @data_documentation_spec = args[:data_documentation_spec] if args.key?(:data_documentation_spec)
  @data_profile_result = args[:data_profile_result] if args.key?(:data_profile_result)
  @data_profile_spec = args[:data_profile_spec] if args.key?(:data_profile_spec)
  @data_quality_result = args[:data_quality_result] if args.key?(:data_quality_result)
  @data_quality_spec = args[:data_quality_spec] if args.key?(:data_quality_spec)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @execution_identity = args[:execution_identity] if args.key?(:execution_identity)
  @execution_spec = args[:execution_spec] if args.key?(:execution_spec)
  @execution_status = args[:execution_status] if args.key?(:execution_status)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
  @uid = args[:uid] if args.key?(:uid)
  @unstructured_data_profile_result = args[:unstructured_data_profile_result] if args.key?(:unstructured_data_profile_result)
  @unstructured_data_profile_spec = args[:unstructured_data_profile_spec] if args.key?(:unstructured_data_profile_spec)
  @update_time = args[:update_time] if args.key?(:update_time)
end