Console
    Contact Us Start free

    Data Loss Prevention V2 Client - Class FileStoreDataProfile (2.6.0)

    Reference documentation and code samples for the Data Loss Prevention V2 Client class FileStoreDataProfile.

    The profile for a file store.

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

    Generated from protobuf message google.privacy.dlp.v2.FileStoreDataProfile

    Namespace

    Google \ Cloud \ Dlp \ V2

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    The name of the profile.

    ↳ data_source_type
    DataSourceType

    The resource type that was profiled.

    ↳ project_data_profile
    string

    The resource name of the project data profile for this file store.

    ↳ project_id
    string

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

    ↳ 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

    ↳ data_storage_locations
    array

    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.

    ↳ 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.

    ↳ 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}

    ↳ 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}

    ↳ config_snapshot
    DataProfileConfigSnapshot

    The snapshot of the configurations used to generate the profile.

    ↳ profile_status
    ProfileStatus

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

    ↳ state
    int

    State of a profile.

    ↳ profile_last_generated
    Google\Protobuf\Timestamp

    The last time the profile was generated.

    ↳ resource_visibility
    int

    How broadly a resource has been shared.

    ↳ sensitivity_score
    SensitivityScore

    The sensitivity score of this resource.

    ↳ data_risk_level
    DataRiskLevel

    The data risk level of this resource.

    ↳ create_time
    Google\Protobuf\Timestamp

    The time the file store was first created.

    ↳ last_modified_time
    Google\Protobuf\Timestamp

    The time the file store was last modified.

    ↳ file_cluster_summaries
    array< FileClusterSummary >

    FileClusterSummary per each cluster.

    ↳ resource_attributes
    array| Google\Protobuf\Internal\MapField

    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
    array| Google\Protobuf\Internal\MapField

    The labels applied to the resource at the time the profile was generated.

    ↳ file_store_info_type_summaries
    array< FileStoreInfoTypeSummary >

    InfoTypes detected in this file store.

    ↳ sample_findings_table
    BigQueryTable

    The BigQuery table to which the sample findings are written.

    ↳ file_store_is_empty
    bool

    The file store does not have any files. If the profiling operation failed, this is false.

    ↳ tags
    array< Tag >

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

    ↳ related_resources
    array< RelatedResource >

    Resources related to this profile.

    getName

    The name of the profile.

    Returns
    Type
    Description
    string

    setName

    The name of the profile.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDataSourceType

    The resource type that was profiled.

    Returns
    Type
    Description
    DataSourceType |null

    hasDataSourceType

    clearDataSourceType

    setDataSourceType

    The resource type that was profiled.

    Parameter
    Name
    Description
    var
    DataSourceType
    Returns
    Type
    Description
    $this

    getProjectDataProfile

    The resource name of the project data profile for this file store.

    Returns
    Type
    Description
    string

    setProjectDataProfile

    The resource name of the project data profile for this file store.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getProjectId

    The Google Cloud project ID that owns the resource.

    For Amazon S3 buckets, this is the AWS Account Id.

    Returns
    Type
    Description
    string

    setProjectId

    The Google Cloud project ID that owns the resource.

    For Amazon S3 buckets, this is the AWS Account Id.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFileStoreLocation

    The location of the file store.

    Returns
    Type
    Description
    string

    setFileStoreLocation

    The location of the file store.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDataStorageLocations

    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
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setDataStorageLocations

    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.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getLocationType

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

    Returns
    Type
    Description
    string

    setLocationType

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFileStorePath

    The file store path.

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

    setFileStorePath

    The file store path.

    • Cloud Storage: gs://{bucket}
    • Amazon S3: s3://{bucket}
    • Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFullResource

    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
    Type
    Description
    string

    setFullResource

    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}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getConfigSnapshot

    The snapshot of the configurations used to generate the profile.

    Returns
    Type
    Description
    DataProfileConfigSnapshot |null

    hasConfigSnapshot

    clearConfigSnapshot

    setConfigSnapshot

    The snapshot of the configurations used to generate the profile.

    Parameter
    Name
    Description
    var
    DataProfileConfigSnapshot
    Returns
    Type
    Description
    $this

    getProfileStatus

    Success or error status from the most recent profile generation attempt.

    May be empty if the profile is still being generated.

    Returns
    Type
    Description
    ProfileStatus |null

    hasProfileStatus

    clearProfileStatus

    setProfileStatus

    Success or error status from the most recent profile generation attempt.

    May be empty if the profile is still being generated.

    Parameter
    Name
    Description
    var
    ProfileStatus
    Returns
    Type
    Description
    $this

    getState

    State of a profile.

    Returns
    Type
    Description
    int

    setState

    State of a profile.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getProfileLastGenerated

    The last time the profile was generated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasProfileLastGenerated

    clearProfileLastGenerated

    setProfileLastGenerated

    The last time the profile was generated.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getResourceVisibility

    How broadly a resource has been shared.

    Returns
    Type
    Description
    int

    setResourceVisibility

    How broadly a resource has been shared.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getSensitivityScore

    The sensitivity score of this resource.

    Returns
    Type
    Description
    SensitivityScore |null

    hasSensitivityScore

    clearSensitivityScore

    setSensitivityScore

    The sensitivity score of this resource.

    Parameter
    Name
    Description
    var
    SensitivityScore
    Returns
    Type
    Description
    $this

    getDataRiskLevel

    The data risk level of this resource.

    Returns
    Type
    Description
    DataRiskLevel |null

    hasDataRiskLevel

    clearDataRiskLevel

    setDataRiskLevel

    The data risk level of this resource.

    Parameter
    Name
    Description
    var
    DataRiskLevel
    Returns
    Type
    Description
    $this

    getCreateTime

    The time the file store was first created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    The time the file store was first created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getLastModifiedTime

    The time the file store was last modified.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasLastModifiedTime

    clearLastModifiedTime

    setLastModifiedTime

    The time the file store was last modified.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getFileClusterSummaries

    FileClusterSummary per each cluster.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setFileClusterSummaries

    FileClusterSummary per each cluster.

    Parameter
    Name
    Description
    var
    array< FileClusterSummary >
    Returns
    Type
    Description
    $this

    getResourceAttributes

    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
    Type
    Description
    Google\Protobuf\Internal\MapField

    setResourceAttributes

    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.
    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getResourceLabels

    The labels applied to the resource at the time the profile was generated.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setResourceLabels

    The labels applied to the resource at the time the profile was generated.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getFileStoreInfoTypeSummaries

    InfoTypes detected in this file store.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setFileStoreInfoTypeSummaries

    InfoTypes detected in this file store.

    Parameter
    Name
    Description
    var
    array< FileStoreInfoTypeSummary >
    Returns
    Type
    Description
    $this

    getSampleFindingsTable

    The BigQuery table to which the sample findings are written.

    Returns
    Type
    Description
    BigQueryTable |null

    hasSampleFindingsTable

    clearSampleFindingsTable

    setSampleFindingsTable

    The BigQuery table to which the sample findings are written.

    Parameter
    Name
    Description
    var
    BigQueryTable
    Returns
    Type
    Description
    $this

    getFileStoreIsEmpty

    The file store does not have any files. If the profiling operation failed, this is false.

    Returns
    Type
    Description
    bool

    setFileStoreIsEmpty

    The file store does not have any files. If the profiling operation failed, this is false.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getTags

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setTags

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

    Parameter
    Name
    Description
    var
    array< Tag >
    Returns
    Type
    Description
    $this

    getRelatedResources

    Resources related to this profile.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setRelatedResources

    Resources related to this profile.

    Parameter
    Name
    Description
    var
    array< RelatedResource >
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: