Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::FileStoreDataProfile (v1.15.0)

Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::FileStoreDataProfile.

The profile for a file store.

  • Cloud Storage: maps 1:1 with a bucket.
  • Amazon S3: maps 1:1 with a bucket.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#config_snapshot

defconfig_snapshot()->::Google::Cloud::Dlp::V2::DataProfileConfigSnapshot
Returns

#config_snapshot=

defconfig_snapshot=(value)->::Google::Cloud::Dlp::V2::DataProfileConfigSnapshot
Parameter
Returns

#create_time

defcreate_time()->::Google::Protobuf::Timestamp
Returns

#create_time=

defcreate_time=(value)->::Google::Protobuf::Timestamp
Parameter
Returns

#data_risk_level

defdata_risk_level()->::Google::Cloud::Dlp::V2::DataRiskLevel
Returns

#data_risk_level=

defdata_risk_level=(value)->::Google::Cloud::Dlp::V2::DataRiskLevel
Parameter
Returns

#data_source_type

defdata_source_type()->::Google::Cloud::Dlp::V2::DataSourceType
Returns

#data_source_type=

defdata_source_type=(value)->::Google::Cloud::Dlp::V2::DataSourceType
Parameter
Returns

#data_storage_locations

defdata_storage_locations()->::Array<::String>
Returns
  • (::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.

#data_storage_locations=

defdata_storage_locations=(value)->::Array<::String>
Parameter
  • value (::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.
Returns
  • (::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.

#domains

defdomains()->::Array<::Google::Cloud::Dlp::V2::Domain>
Returns

#domains=

defdomains=(value)->::Array<::Google::Cloud::Dlp::V2::Domain>
Parameter
Returns

#file_cluster_summaries

deffile_cluster_summaries()->::Array<::Google::Cloud::Dlp::V2::FileClusterSummary>
Returns

#file_cluster_summaries=

deffile_cluster_summaries=(value)->::Array<::Google::Cloud::Dlp::V2::FileClusterSummary>
Parameter
Returns

#file_store_info_type_summaries

deffile_store_info_type_summaries()->::Array<::Google::Cloud::Dlp::V2::FileStoreInfoTypeSummary>
Returns

#file_store_info_type_summaries=

deffile_store_info_type_summaries=(value)->::Array<::Google::Cloud::Dlp::V2::FileStoreInfoTypeSummary>
Parameter
Returns

#file_store_is_empty

deffile_store_is_empty()->::Boolean
Returns
  • (::Boolean) — The file store does not have any files. If the profiling operation failed, this is false.

#file_store_is_empty=

deffile_store_is_empty=(value)->::Boolean
Parameter
  • value (::Boolean) — The file store does not have any files. If the profiling operation failed, this is false.
Returns
  • (::Boolean) — The file store does not have any files. If the profiling operation failed, this is false.

#file_store_location

deffile_store_location()->::String
Returns
  • (::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

#file_store_location=

deffile_store_location=(value)->::String
Parameter
  • value (::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
Returns
  • (::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

#file_store_path

deffile_store_path()->::String
Returns
  • (::String) —

    The file store path.

    • Cloud Storage: gs://{bucket}
    • Amazon S3: s3://{bucket}
    • Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}

#file_store_path=

deffile_store_path=(value)->::String
Parameter
  • value (::String) —

    The file store path.

    • Cloud Storage: gs://{bucket}
    • Amazon S3: s3://{bucket}
    • Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}
Returns
  • (::String) —

    The file store path.

    • Cloud Storage: gs://{bucket}
    • Amazon S3: s3://{bucket}
    • Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}

#full_resource

deffull_resource()->::String
Returns
  • (::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}

#full_resource=

deffull_resource=(value)->::String
Parameter
  • value (::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}

Returns
  • (::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}

#last_modified_time

deflast_modified_time()->::Google::Protobuf::Timestamp
Returns

#last_modified_time=

deflast_modified_time=(value)->::Google::Protobuf::Timestamp
Parameter
Returns

#location_type

deflocation_type()->::String
Returns
  • (::String) — The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.

#location_type=

deflocation_type=(value)->::String
Parameter
  • value (::String) — The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.
Returns
  • (::String) — The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.

#name

defname()->::String
Returns
  • (::String) — The name of the profile.

#name=

defname=(value)->::String
Parameter
  • value (::String) — The name of the profile.
Returns
  • (::String) — The name of the profile.

#profile_last_generated

defprofile_last_generated()->::Google::Protobuf::Timestamp
Returns

#profile_last_generated=

defprofile_last_generated=(value)->::Google::Protobuf::Timestamp
Parameter
Returns

#profile_status

defprofile_status()->::Google::Cloud::Dlp::V2::ProfileStatus
Returns

#profile_status=

defprofile_status=(value)->::Google::Cloud::Dlp::V2::ProfileStatus
Parameter
Returns

#project_data_profile

defproject_data_profile()->::String
Returns
  • (::String) — The resource name of the project data profile for this file store.

#project_data_profile=

defproject_data_profile=(value)->::String
Parameter
  • value (::String) — The resource name of the project data profile for this file store.
Returns
  • (::String) — The resource name of the project data profile for this file store.

#project_id

defproject_id()->::String
Returns
  • (::String) — The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.

#project_id=

defproject_id=(value)->::String
Parameter
  • value (::String) — The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.
Returns
  • (::String) — The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.
defrelated_resources()->::Array<::Google::Cloud::Dlp::V2::RelatedResource>
Returns
defrelated_resources=(value)->::Array<::Google::Cloud::Dlp::V2::RelatedResource>
Parameter
Returns

#resource_attributes

defresource_attributes()->::Google::Protobuf::Map{::String=>::Google::Cloud::Dlp::V2::Value}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Dlp::V2::Value}) —

    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.

#resource_attributes=

defresource_attributes=(value)->::Google::Protobuf::Map{::String=>::Google::Cloud::Dlp::V2::Value}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Dlp::V2::Value}) —

    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.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Dlp::V2::Value}) —

    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.

#resource_labels

defresource_labels()->::Google::Protobuf::Map{::String=>::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The labels applied to the resource at the time the profile was generated.

#resource_labels=

defresource_labels=(value)->::Google::Protobuf::Map{::String=>::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — The labels applied to the resource at the time the profile was generated.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The labels applied to the resource at the time the profile was generated.

#resource_visibility

defresource_visibility()->::Google::Cloud::Dlp::V2::ResourceVisibility
Returns

#resource_visibility=

defresource_visibility=(value)->::Google::Cloud::Dlp::V2::ResourceVisibility
Parameter
Returns

#sample_findings_table

defsample_findings_table()->::Google::Cloud::Dlp::V2::BigQueryTable
Returns

#sample_findings_table=

defsample_findings_table=(value)->::Google::Cloud::Dlp::V2::BigQueryTable
Parameter
Returns

#sensitivity_score

defsensitivity_score()->::Google::Cloud::Dlp::V2::SensitivityScore
Returns

#sensitivity_score=

defsensitivity_score=(value)->::Google::Cloud::Dlp::V2::SensitivityScore
Parameter
Returns

#state

defstate()->::Google::Cloud::Dlp::V2::FileStoreDataProfile::State
Returns

#state=

defstate=(value)->::Google::Cloud::Dlp::V2::FileStoreDataProfile::State
Parameter
Returns

#tags

deftags()->::Array<::Google::Cloud::Dlp::V2::Tag>
Returns

#tags=

deftags=(value)->::Array<::Google::Cloud::Dlp::V2::Tag>
Parameter
Returns

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.