Class: Google::Apis::DlpV2::GooglePrivacyDlpV2ColumnDataProfile

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

Overview

The profile for a scanned column within a table.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2ColumnDataProfile

Returns a new instance of GooglePrivacyDlpV2ColumnDataProfile.



1225
1226
1227
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1225

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

Instance Attribute Details

#column ⇒ String

The name of the column. Corresponds to the JSON property column

Returns:

  • (String) 


1122
1123
1124
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1122

def column
  @column
end

#column_info_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InfoTypeSummary

The infoType details for this column. Corresponds to the JSON property columnInfoType

Returns:



1127
1128
1129
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1127

def column_info_type
  @column_info_type
end

#column_type ⇒ String

The data type of a given column. Corresponds to the JSON property columnType

Returns:

  • (String) 


1132
1133
1134
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1132

def column_type
  @column_type
end

#data_risk_level ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DataRiskLevel

Score is a summary of all elements in the data profile. A higher number means more risk. Corresponds to the JSON property dataRiskLevel

Returns:



1138
1139
1140
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1138

def data_risk_level
  @data_risk_level
end

#dataset_id ⇒ String

The BigQuery dataset ID. Corresponds to the JSON property datasetId

Returns:

  • (String) 


1143
1144
1145
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1143

def dataset_id
  @dataset_id
end

#dataset_location ⇒ String

The BigQuery location where the dataset's data is stored. See https://cloud. google.com/bigquery/docs/locations for supported locations. Corresponds to the JSON property datasetLocation

Returns:

  • (String) 


1149
1150
1151
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1149

def dataset_location
  @dataset_location
end

#dataset_project_id ⇒ String

The Google Cloud project ID that owns the BigQuery dataset. Corresponds to the JSON property datasetProjectId

Returns:

  • (String) 


1154
1155
1156
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1154

def dataset_project_id
  @dataset_project_id
end

#estimated_null_percentage ⇒ String

Approximate percentage of entries being null in the column. Corresponds to the JSON property estimatedNullPercentage

Returns:

  • (String) 


1159
1160
1161
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1159

def estimated_null_percentage
  @estimated_null_percentage
end

#estimated_uniqueness_score ⇒ String

Approximate uniqueness of the column. Corresponds to the JSON property estimatedUniquenessScore

Returns:

  • (String) 


1164
1165
1166
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1164

def estimated_uniqueness_score
  @estimated_uniqueness_score
end

#free_text_score ⇒ Float

The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1. Corresponds to the JSON property freeTextScore

Returns:

  • (Float) 


1171
1172
1173
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1171

def free_text_score
  @free_text_score
end

#name ⇒ String

The name of the profile. Corresponds to the JSON property name

Returns:

  • (String) 


1176
1177
1178
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1176

def name
  @name
end

#other_matches ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2OtherInfoTypeSummary>

Other types found within this column. List will be unordered. Corresponds to the JSON property otherMatches

Returns:



1181
1182
1183
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1181

def other_matches
  @other_matches
end

#policy_state ⇒ String

Indicates if a policy tag has been applied to the column. Corresponds to the JSON property policyState

Returns:

  • (String) 


1186
1187
1188
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1186

def policy_state
  @policy_state
end

#profile_last_generated ⇒ String

The last time the profile was generated. Corresponds to the JSON property profileLastGenerated

Returns:

  • (String) 


1191
1192
1193
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1191

def profile_last_generated
  @profile_last_generated
end

#profile_status ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ProfileStatus

Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated. Corresponds to the JSON property profileStatus

Returns:



1197
1198
1199
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1197

def profile_status
  @profile_status
end

#sensitivity_score ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2SensitivityScore

Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. Corresponds to the JSON property sensitivityScore

Returns:



1203
1204
1205
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1203

def sensitivity_score
  @sensitivity_score
end

#state ⇒ String

State of a profile. Corresponds to the JSON property state

Returns:

  • (String) 


1208
1209
1210
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1208

def state
  @state
end

#table_data_profile ⇒ String

The resource name of the table data profile. Corresponds to the JSON property tableDataProfile

Returns:

  • (String) 


1213
1214
1215
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1213

def table_data_profile
  @table_data_profile
end

#table_full_resource ⇒ String

The resource name of the table this column is within. Corresponds to the JSON property tableFullResource

Returns:

  • (String) 


1218
1219
1220
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1218

def table_full_resource
  @table_full_resource
end

#table_id ⇒ String

The BigQuery table ID. Corresponds to the JSON property tableId

Returns:

  • (String) 


1223
1224
1225
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1223

def table_id
  @table_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1230

def update!(**args)
  @column = args[:column] if args.key?(:column)
  @column_info_type = args[:column_info_type] if args.key?(:column_info_type)
  @column_type = args[:column_type] if args.key?(:column_type)
  @data_risk_level = args[:data_risk_level] if args.key?(:data_risk_level)
  @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
  @dataset_location = args[:dataset_location] if args.key?(:dataset_location)
  @dataset_project_id = args[:dataset_project_id] if args.key?(:dataset_project_id)
  @estimated_null_percentage = args[:estimated_null_percentage] if args.key?(:estimated_null_percentage)
  @estimated_uniqueness_score = args[:estimated_uniqueness_score] if args.key?(:estimated_uniqueness_score)
  @free_text_score = args[:free_text_score] if args.key?(:free_text_score)
  @name = args[:name] if args.key?(:name)
  @other_matches = args[:other_matches] if args.key?(:other_matches)
  @policy_state = args[:policy_state] if args.key?(:policy_state)
  @profile_last_generated = args[:profile_last_generated] if args.key?(:profile_last_generated)
  @profile_status = args[:profile_status] if args.key?(:profile_status)
  @sensitivity_score = args[:sensitivity_score] if args.key?(:sensitivity_score)
  @state = args[:state] if args.key?(:state)
  @table_data_profile = args[:table_data_profile] if args.key?(:table_data_profile)
  @table_full_resource = args[:table_full_resource] if args.key?(:table_full_resource)
  @table_id = args[:table_id] if args.key?(:table_id)
end