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

Version latest

• 1.5.0 (latest)
• 1.4.0
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.2
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1

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

def config_snapshot() -> ::Google::Cloud::Dlp::V2::DataProfileConfigSnapshot

Returns

• (::Google::Cloud::Dlp::V2::DataProfileConfigSnapshot) — The snapshot of the configurations used to generate the profile.

#config_snapshot=

def config_snapshot=(value) -> ::Google::Cloud::Dlp::V2::DataProfileConfigSnapshot

Parameter

• value (::Google::Cloud::Dlp::V2::DataProfileConfigSnapshot) — The snapshot of the configurations used to generate the profile.

Returns

• (::Google::Cloud::Dlp::V2::DataProfileConfigSnapshot) — The snapshot of the configurations used to generate the profile.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — The time the file store was first created.

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — The time the file store was first created.

Returns

• (::Google::Protobuf::Timestamp) — The time the file store was first created.

#data_risk_level

def data_risk_level() -> ::Google::Cloud::Dlp::V2::DataRiskLevel

Returns

• (::Google::Cloud::Dlp::V2::DataRiskLevel) — The data risk level of this resource.

#data_risk_level=

def data_risk_level=(value) -> ::Google::Cloud::Dlp::V2::DataRiskLevel

Parameter

• value (::Google::Cloud::Dlp::V2::DataRiskLevel) — The data risk level of this resource.

Returns

• (::Google::Cloud::Dlp::V2::DataRiskLevel) — The data risk level of this resource.

#data_source_type

def data_source_type() -> ::Google::Cloud::Dlp::V2::DataSourceType

Returns

• (::Google::Cloud::Dlp::V2::DataSourceType) — The resource type that was profiled.

#data_source_type=

def data_source_type=(value) -> ::Google::Cloud::Dlp::V2::DataSourceType

Parameter

• value (::Google::Cloud::Dlp::V2::DataSourceType) — The resource type that was profiled.

Returns

• (::Google::Cloud::Dlp::V2::DataSourceType) — The resource type that was profiled.

#data_storage_locations

def data_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=

def data_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.

#file_cluster_summaries

def file_cluster_summaries() -> ::Array<::Google::Cloud::Dlp::V2::FileClusterSummary>

Returns

• (::Array<::Google::Cloud::Dlp::V2::FileClusterSummary>) — FileClusterSummary per each cluster.

#file_cluster_summaries=

def file_cluster_summaries=(value) -> ::Array<::Google::Cloud::Dlp::V2::FileClusterSummary>

Parameter

• value (::Array<::Google::Cloud::Dlp::V2::FileClusterSummary>) — FileClusterSummary per each cluster.

Returns

• (::Array<::Google::Cloud::Dlp::V2::FileClusterSummary>) — FileClusterSummary per each cluster.

#file_store_info_type_summaries

def file_store_info_type_summaries() -> ::Array<::Google::Cloud::Dlp::V2::FileStoreInfoTypeSummary>

Returns

• (::Array<::Google::Cloud::Dlp::V2::FileStoreInfoTypeSummary>) — InfoTypes detected in this file store.

#file_store_info_type_summaries=

def file_store_info_type_summaries=(value) -> ::Array<::Google::Cloud::Dlp::V2::FileStoreInfoTypeSummary>

Parameter

• value (::Array<::Google::Cloud::Dlp::V2::FileStoreInfoTypeSummary>) — InfoTypes detected in this file store.

Returns

• (::Array<::Google::Cloud::Dlp::V2::FileStoreInfoTypeSummary>) — InfoTypes detected in this file store.

#file_store_is_empty

def file_store_is_empty() -> ::Boolean

Returns

• (::Boolean) — The file store does not have any files.

#file_store_is_empty=

def file_store_is_empty=(value) -> ::Boolean

Parameter

• value (::Boolean) — The file store does not have any files.

Returns

• (::Boolean) — The file store does not have any files.

#file_store_location

def file_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=

def file_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

def file_store_path() -> ::String

Returns

• (::String) —

  The file store path.

  • Cloud Storage: gs://{bucket}
  • Amazon S3: s3://{bucket}

#file_store_path=

def file_store_path=(value) -> ::String

Parameter

• value (::String) —

  The file store path.

  • Cloud Storage: gs://{bucket}
  • Amazon S3: s3://{bucket}

Returns

• (::String) —

  The file store path.

  • Cloud Storage: gs://{bucket}
  • Amazon S3: s3://{bucket}

#full_resource

def full_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=

def full_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

def last_modified_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — The time the file store was last modified.

#last_modified_time=

def last_modified_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — The time the file store was last modified.

Returns

• (::Google::Protobuf::Timestamp) — The time the file store was last modified.

#location_type

def location_type() -> ::String

Returns

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

#location_type=

def location_type=(value) -> ::String

Parameter

• value (::String) — The location type of the bucket (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.

Returns

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

#name

def name() -> ::String

Returns

• (::String) — The name of the profile.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — The name of the profile.

Returns

• (::String) — The name of the profile.

#profile_last_generated

def profile_last_generated() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — The last time the profile was generated.

#profile_last_generated=

def profile_last_generated=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — The last time the profile was generated.

Returns

• (::Google::Protobuf::Timestamp) — The last time the profile was generated.

#profile_status

def profile_status() -> ::Google::Cloud::Dlp::V2::ProfileStatus

Returns

• (::Google::Cloud::Dlp::V2::ProfileStatus) — Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

#profile_status=

def profile_status=(value) -> ::Google::Cloud::Dlp::V2::ProfileStatus

Parameter

• value (::Google::Cloud::Dlp::V2::ProfileStatus) — Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

Returns

• (::Google::Cloud::Dlp::V2::ProfileStatus) — Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

#project_data_profile

def project_data_profile() -> ::String

Returns

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

#project_data_profile=

def project_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

def project_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=

def project_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.

#resource_attributes

def resource_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=

def resource_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

def resource_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=

def resource_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

def resource_visibility() -> ::Google::Cloud::Dlp::V2::ResourceVisibility

Returns

• (::Google::Cloud::Dlp::V2::ResourceVisibility) — How broadly a resource has been shared.

#resource_visibility=

def resource_visibility=(value) -> ::Google::Cloud::Dlp::V2::ResourceVisibility

Parameter

• value (::Google::Cloud::Dlp::V2::ResourceVisibility) — How broadly a resource has been shared.

Returns

• (::Google::Cloud::Dlp::V2::ResourceVisibility) — How broadly a resource has been shared.

#sensitivity_score

def sensitivity_score() -> ::Google::Cloud::Dlp::V2::SensitivityScore

Returns

• (::Google::Cloud::Dlp::V2::SensitivityScore) — The sensitivity score of this resource.

#sensitivity_score=

def sensitivity_score=(value) -> ::Google::Cloud::Dlp::V2::SensitivityScore

Parameter

• value (::Google::Cloud::Dlp::V2::SensitivityScore) — The sensitivity score of this resource.

Returns

• (::Google::Cloud::Dlp::V2::SensitivityScore) — The sensitivity score of this resource.

#state

def state() -> ::Google::Cloud::Dlp::V2::FileStoreDataProfile::State

Returns

• (::Google::Cloud::Dlp::V2::FileStoreDataProfile::State) — State of a profile.

#state=

def state=(value) -> ::Google::Cloud::Dlp::V2::FileStoreDataProfile::State

Parameter

• value (::Google::Cloud::Dlp::V2::FileStoreDataProfile::State) — State of a profile.

Returns

• (::Google::Cloud::Dlp::V2::FileStoreDataProfile::State) — State of a profile.