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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1DataScan

Returns a new instance of GoogleCloudDataplexV1DataScan.



2024
2025
2026
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2024

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) 


1943
1944
1945
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1943

def create_time
  @create_time
end

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

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

Returns:



1948
1949
1950
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1948

def data
  @data
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:



1954
1955
1956
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1954

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:



1959
1960
1961
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1959

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:



1964
1965
1966
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1964

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:



1969
1970
1971
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1969

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) 


1974
1975
1976
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1974

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) 


1979
1980
1981
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1979

def display_name
  @display_name
end

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

DataScan execution settings. Corresponds to the JSON property executionSpec

Returns:



1984
1985
1986
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1984

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:



1989
1990
1991
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1989

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


1994
1995
1996
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1994

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


2001
2002
2003
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2001

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


2006
2007
2008
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2006

def state
  @state
end

#type ⇒ String

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

Returns:

  • (String) 


2011
2012
2013
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2011

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) 


2017
2018
2019
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2017

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


2022
2023
2024
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2022

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2029

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data = args[:data] if args.key?(:data)
  @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_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)
  @update_time = args[:update_time] if args.key?(:update_time)
end