REST Resource: organizations.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)
    }
  ],
  "sampleFindingsTable": {
    object (BigQueryTable)
  },
  "fileStoreIsEmpty": boolean
}
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 bucket (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}
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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastModifiedTime

string (Timestamp format)

The time the file store was last modified.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
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.
sampleFindingsTable

object (BigQueryTable)

The BigQuery table to which the sample findings are written.
fileStoreIsEmpty

boolean

The file store does not have any files.

State

Possible states of a profile. New items may be added.

Enums
STATE_UNSPECIFIED Unused.
RUNNING The profile is currently running. Once a profile has finished it will transition to DONE.
DONE The profile is no longer generating. If profileStatus.status.code is 0, the profile succeeded, otherwise, it failed.

FileClusterSummary

The file cluster summary.

JSON representation 
{
  "fileClusterType": {
    object (FileClusterType)
  },
  "fileStoreInfoTypeSummaries": [
    {
      object (FileStoreInfoTypeSummary)
    }
  ],
  "sensitivityScore": {
    object (SensitivityScore)
  },
  "dataRiskLevel": {
    object (DataRiskLevel)
  },
  "errors": [
    {
      object (Error)
    }
  ],
  "fileExtensionsScanned": [
    {
      object (FileExtensionInfo)
    }
  ],
  "fileExtensionsSeen": [
    {
      object (FileExtensionInfo)
    }
  ],
  "noFilesExist": boolean
}
Fields
fileClusterType

object (FileClusterType)

The file cluster type.
fileStoreInfoTypeSummaries[]

object (FileStoreInfoTypeSummary)

InfoTypes detected in this cluster.
sensitivityScore

object (SensitivityScore)

The sensitivity score of this cluster. The score will be SENSITIVITY_LOW if nothing has been scanned.
dataRiskLevel

object (DataRiskLevel)

The data risk level of this cluster. RISK_LOW if nothing has been scanned.
errors[]

object (Error)

A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster.
fileExtensionsScanned[]

object (FileExtensionInfo)

A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content.
fileExtensionsSeen[]

object (FileExtensionInfo)

A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content.
noFilesExist

boolean

True if no files exist in this cluster. If the bucket had more files than could be listed, this will be false even if no files for this cluster were seen and fileExtensionsSeen is empty.

FileClusterType

Message used to identify file cluster type being profiled.

JSON representation 
{

  // Union field file_cluster_type can be only one of the following:
  "cluster": enum (Cluster)
  // End of list of possible types for union field file_cluster_type.
}
Fields
Union field file_cluster_type. File cluster type. file_cluster_type can be only one of the following:
cluster

enum (Cluster)

Cluster type.

Cluster

Cluster type. Each cluster corresponds to a set of file types. Over time, new types may be added and files may move between clusters.

Enums
CLUSTER_UNSPECIFIED Unused.
CLUSTER_UNKNOWN Unsupported files.
CLUSTER_TEXT Plain text.
CLUSTER_STRUCTURED_DATA Structured data like CSV, TSV etc.
CLUSTER_SOURCE_CODE Source code.
CLUSTER_RICH_DOCUMENT Rich document like docx, xlsx etc.
CLUSTER_IMAGE Images like jpeg, bmp.
CLUSTER_ARCHIVE Archives and containers like .zip, .tar etc.
CLUSTER_MULTIMEDIA Multimedia like .mp4, .avi etc.
CLUSTER_EXECUTABLE Executable files like .exe, .class, .apk etc.

FileStoreInfoTypeSummary

Information regarding the discovered InfoType.

JSON representation 
{
  "infoType": {
    object (InfoType)
  }
}
Fields
infoType

object (InfoType)

The InfoType seen.

FileExtensionInfo

Information regarding the discovered file extension.

JSON representation 
{
  "fileExtension": string
}
Fields
fileExtension

string

The file extension if set. (aka .pdf, .jpg, .txt)

Methods

delete

 Delete a FileStoreDataProfile.

get

 Gets a file store data profile.

list

 Lists file store data profiles for an organization.