REST Resource: projects.locations.fileStoreDataProfiles

Resource: FileStoreDataProfile

The profile for a file store.

  • Cloud Storage: maps 1:1 with a bucket.
  • Amazon S3: maps 1:1 with a bucket.
JSON representation 
{
  "name": string,
  "dataSourceType": {
    object (DataSourceType)
  },
  "projectDataProfile": string,
  "projectId": string,
  "fileStoreLocation": string,
  "dataStorageLocations": [
    string
  ],
  "locationType": string,
  "fileStorePath": string,
  "fullResource": string,
  "configSnapshot": {
    object (DataProfileConfigSnapshot)
  },
  "profileStatus": {
    object (ProfileStatus)
  },
  "state": enum (State),
  "profileLastGenerated": string,
  "resourceVisibility": enum (ResourceVisibility),
  "sensitivityScore": {
    object (SensitivityScore)
  },
  "dataRiskLevel": {
    object (DataRiskLevel)
  },
  "createTime": string,
  "lastModifiedTime": string,
  "fileClusterSummaries": [
    {
      object (FileClusterSummary)
    }
  ],
  "resourceAttributes": {
    string: {
      object (Value)
    },
    ...
  },
  "resourceLabels": {
    string: string,
    ...
  },
  "fileStoreInfoTypeSummaries": [
    {
      object (FileStoreInfoTypeSummary)
    }
  ],
  "fileStoreIsEmpty": boolean,
  "relatedResources": [
    {
      object (RelatedResource)
    }
  ]
}
Fields
name

string

The name of the profile.
dataSourceType

object (DataSourceType)

The resource type that was profiled.
projectDataProfile

string

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

string

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

string

The location of the file store.
dataStorageLocations[]

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. fileStoreLocation 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.
locationType

string

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

string

The file store path.

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

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:::{bucketName}
configSnapshot

object (DataProfileConfigSnapshot)

The snapshot of the configurations used to generate the profile.
profileStatus

object (ProfileStatus)

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

enum (State)

State of a profile.
profileLastGenerated

string (Timestamp format)

The last time the profile was generated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
resourceVisibility

enum (ResourceVisibility)

How broadly a resource has been shared.
sensitivityScore

object (SensitivityScore)

The sensitivity score of this resource.
dataRiskLevel

object (DataRiskLevel)

The data risk level of this resource.
createTime

string (Timestamp format)

The time the file store was first created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
lastModifiedTime

string (Timestamp format)

The time the file store was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
fileClusterSummaries[]

object (FileClusterSummary)

FileClusterSummary per each cluster.
resourceAttributes

map (key: string, value: object (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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
resourceLabels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
fileStoreInfoTypeSummaries[]

object (FileStoreInfoTypeSummary)

InfoTypes detected in this file store.
fileStoreIsEmpty

boolean

The file store does not have any files.
relatedResources[]

object (RelatedResource)

Resources related to this profile.

Methods

delete

 Delete a FileStoreDataProfile.

get

 Gets a file store data profile.

list

 Lists file store data profiles for an organization.