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.



5601
5602
5603
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5601

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:



5446
5447
5448
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5446

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) 


5451
5452
5453
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5451

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:



5457
5458
5459
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5457

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:



5462
5463
5464
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5462

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


5471
5472
5473
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5471

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:



5476
5477
5478
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5476

def domains
  @domains
end

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

FileClusterSummary per each cluster. Corresponds to the JSON property fileClusterSummaries

Returns:



5481
5482
5483
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5481

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:



5486
5487
5488
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5486

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) 


5492
5493
5494
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5492

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) 


5500
5501
5502
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5500

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) 


5507
5508
5509
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5507

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) 


5515
5516
5517
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5515

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) 


5520
5521
5522
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5520

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) 


5526
5527
5528
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5526

def location_type
  @location_type
end

#name ⇒ String

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

Returns:

  • (String) 


5531
5532
5533
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5531

def name
  @name
end

#profile_last_generated ⇒ String

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

Returns:

  • (String) 


5536
5537
5538
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5536

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:



5541
5542
5543
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5541

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) 


5546
5547
5548
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5546

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) 


5552
5553
5554
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5552

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:



5557
5558
5559
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5557

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:



5565
5566
5567
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5565

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


5570
5571
5572
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5570

def resource_labels
  @resource_labels
end

#resource_visibility ⇒ String

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

Returns:

  • (String) 


5575
5576
5577
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5575

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:



5582
5583
5584
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5582

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:



5588
5589
5590
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5588

def sensitivity_score
  @sensitivity_score
end

#state ⇒ String

State of a profile. Corresponds to the JSON property state

Returns:

  • (String) 


5593
5594
5595
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5593

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:



5599
5600
5601
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5599

def tags
  @tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5606

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