Class: Google::Apis::DlpV2::GooglePrivacyDlpV2FileStoreDataProfile

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 file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2FileStoreDataProfile

Returns a new instance of GooglePrivacyDlpV2FileStoreDataProfile.



5228
5229
5230
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5228

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

Instance Attribute Details

#config_snapshot ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DataProfileConfigSnapshot

Snapshot of the configurations used to generate the profile. Corresponds to the JSON property configSnapshot

Returns:



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

def config_snapshot
  @config_snapshot
end

#create_time ⇒ String

The time the file store was first created. Corresponds to the JSON property createTime

Returns:

  • (String) 


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

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



5084
5085
5086
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5084

def data_risk_level
  @data_risk_level
end

#data_source_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DataSourceType

Message used to identify the type of resource being profiled. Corresponds to the JSON property dataSourceType

Returns:



5089
5090
5091
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5089

def data_source_type
  @data_source_type
end

#data_storage_locations ⇒ Array<String>

For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. file_store_location will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile. Corresponds to the JSON property dataStorageLocations

Returns:

  • (Array<String>) 


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

def data_storage_locations
  @data_storage_locations
end

#domains ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2Domain>

Domains associated with the profile. Corresponds to the JSON property domains

Returns:



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

def domains
  @domains
end

#file_cluster_summaries ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2FileClusterSummary>

FileClusterSummary per each cluster. Corresponds to the JSON property fileClusterSummaries

Returns:



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

def file_cluster_summaries
  @file_cluster_summaries
end

#file_store_info_type_summaries ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2FileStoreInfoTypeSummary>

InfoTypes detected in this file store. Corresponds to the JSON property fileStoreInfoTypeSummaries

Returns:



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

def file_store_info_type_summaries
  @file_store_info_type_summaries
end

#file_store_is_empty ⇒ Boolean Also known as: file_store_is_empty?

The file store does not have any files. If the profiling operation failed, this is false. Corresponds to the JSON property fileStoreIsEmpty

Returns:

  • (Boolean) 


5119
5120
5121
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5119

def file_store_is_empty
  @file_store_is_empty
end

#file_store_location ⇒ String

The location of the file store. * Cloud Storage: https://cloud.google.com/ storage/docs/locations#available-locations * Amazon S3: https://docs.aws. amazon.com/general/latest/gr/rande.html#regional-endpoints Corresponds to the JSON property fileStoreLocation

Returns:

  • (String) 


5127
5128
5129
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5127

def file_store_location
  @file_store_location
end

#file_store_path ⇒ String

The file store path. * Cloud Storage: gs://bucket* Amazon S3: `s3://` bucket * Vertex AI dataset: projects/project_number/locations/location/ datasets/dataset_id` Corresponds to the JSON propertyfileStorePath`

Returns:

  • (String) 


5134
5135
5136
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5134

def file_store_path
  @file_store_path
end

#full_resource ⇒ String

The resource name of the resource profiled. https://cloud.google.com/apis/ design/resource_names#full_resource_name Example format of an S3 bucket full resource name: //cloudasset.googleapis.com/organizations/org_id/ otherCloudConnections/aws/arn:aws:s3:::bucket_name` Corresponds to the JSON propertyfullResource`

Returns:

  • (String) 


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

def full_resource
  @full_resource
end

#last_modified_time ⇒ String

The time the file store was last modified. Corresponds to the JSON property lastModifiedTime

Returns:

  • (String) 


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

def last_modified_time
  @last_modified_time
end

#location_type ⇒ String

The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated. Corresponds to the JSON property locationType

Returns:

  • (String) 


5153
5154
5155
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5153

def location_type
  @location_type
end

#name ⇒ String

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

Returns:

  • (String) 


5158
5159
5160
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5158

def name
  @name
end

#profile_last_generated ⇒ String

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

Returns:

  • (String) 


5163
5164
5165
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5163

def profile_last_generated
  @profile_last_generated
end

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

Success or errors for the profile generation. Corresponds to the JSON property profileStatus

Returns:



5168
5169
5170
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5168

def profile_status
  @profile_status
end

#project_data_profile ⇒ String

The resource name of the project data profile for this file store. Corresponds to the JSON property projectDataProfile

Returns:

  • (String) 


5173
5174
5175
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5173

def project_data_profile
  @project_data_profile
end

#project_id ⇒ String

The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id. Corresponds to the JSON property projectId

Returns:

  • (String) 


5179
5180
5181
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5179

def project_id
  @project_id
end

#related_resources ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2RelatedResource>

Resources related to this profile. Corresponds to the JSON property relatedResources

Returns:



5184
5185
5186
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5184

def related_resources
  @related_resources
end

#resource_attributes ⇒ Hash<String,Google::Apis::DlpV2::GooglePrivacyDlpV2Value>

Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider- managed key. Corresponds to the JSON property resourceAttributes

Returns:



5192
5193
5194
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5192

def resource_attributes
  @resource_attributes
end

#resource_labels ⇒ Hash<String,String>

The labels applied to the resource at the time the profile was generated. Corresponds to the JSON property resourceLabels

Returns:

  • (Hash<String,String>) 


5197
5198
5199
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5197

def resource_labels
  @resource_labels
end

#resource_visibility ⇒ String

How broadly a resource has been shared. Corresponds to the JSON property resourceVisibility

Returns:

  • (String) 


5202
5203
5204
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5202

def resource_visibility
  @resource_visibility
end

#sample_findings_table ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2BigQueryTable

Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: :. or ... Corresponds to the JSON property sampleFindingsTable

Returns:



5209
5210
5211
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5209

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



5215
5216
5217
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5215

def sensitivity_score
  @sensitivity_score
end

#state ⇒ String

State of a profile. Corresponds to the JSON property state

Returns:

  • (String) 


5220
5221
5222
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5220

def state
  @state
end

#tags ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2Tag>

The tags attached to the resource, including any tags attached during profiling. Corresponds to the JSON property tags

Returns:



5226
5227
5228
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5226

def tags
  @tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5233

def update!(**args)
  @config_snapshot = args[:config_snapshot] if args.key?(:config_snapshot)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_risk_level = args[:data_risk_level] if args.key?(:data_risk_level)
  @data_source_type = args[:data_source_type] if args.key?(:data_source_type)
  @data_storage_locations = args[:data_storage_locations] if args.key?(:data_storage_locations)
  @domains = args[:domains] if args.key?(:domains)
  @file_cluster_summaries = args[:file_cluster_summaries] if args.key?(:file_cluster_summaries)
  @file_store_info_type_summaries = args[:file_store_info_type_summaries] if args.key?(:file_store_info_type_summaries)
  @file_store_is_empty = args[:file_store_is_empty] if args.key?(:file_store_is_empty)
  @file_store_location = args[:file_store_location] if args.key?(:file_store_location)
  @file_store_path = args[:file_store_path] if args.key?(:file_store_path)
  @full_resource = args[:full_resource] if args.key?(:full_resource)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @location_type = args[:location_type] if args.key?(:location_type)
  @name = args[:name] if args.key?(:name)
  @profile_last_generated = args[:profile_last_generated] if args.key?(:profile_last_generated)
  @profile_status = args[:profile_status] if args.key?(:profile_status)
  @project_data_profile = args[:project_data_profile] if args.key?(:project_data_profile)
  @project_id = args[:project_id] if args.key?(:project_id)
  @related_resources = args[:related_resources] if args.key?(:related_resources)
  @resource_attributes = args[:resource_attributes] if args.key?(:resource_attributes)
  @resource_labels = args[:resource_labels] if args.key?(:resource_labels)
  @resource_visibility = args[:resource_visibility] if args.key?(:resource_visibility)
  @sample_findings_table = args[:sample_findings_table] if args.key?(:sample_findings_table)
  @sensitivity_score = args[:sensitivity_score] if args.key?(:sensitivity_score)
  @state = args[:state] if args.key?(:state)
  @tags = args[:tags] if args.key?(:tags)
end