REST Resource: organizations.locations.tableDataProfiles

Resource: TableDataProfile

The profile for a scanned table.

JSON representation 
{
  "name": string,
  "dataSourceType": {
    object (DataSourceType)
  },
  "projectDataProfile": string,
  "datasetProjectId": string,
  "datasetLocation": string,
  "datasetId": string,
  "tableId": string,
  "fullResource": string,
  "profileStatus": {
    object (ProfileStatus)
  },
  "state": enum (State),
  "sensitivityScore": {
    object (SensitivityScore)
  },
  "dataRiskLevel": {
    object (DataRiskLevel)
  },
  "predictedInfoTypes": [
    {
      object (InfoTypeSummary)
    }
  ],
  "otherInfoTypes": [
    {
      object (OtherInfoTypeSummary)
    }
  ],
  "configSnapshot": {
    object (DataProfileConfigSnapshot)
  },
  "lastModifiedTime": string,
  "expirationTime": string,
  "scannedColumnCount": string,
  "failedColumnCount": string,
  "tableSizeBytes": string,
  "rowCount": string,
  "encryptionStatus": enum (EncryptionStatus),
  "resourceVisibility": enum (ResourceVisibility),
  "profileLastGenerated": string,
  "resourceLabels": {
    string: string,
    ...
  },
  "createTime": string
}
Fields
name

string

The name of the profile.
dataSourceType

object (DataSourceType)

The resource type that was profiled.
projectDataProfile

string

The resource name to the project data profile for this table.
datasetProjectId

string

The Google Cloud project ID that owns the resource.
datasetLocation

string

If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.
datasetId

string

If the resource is BigQuery, the dataset ID.
tableId

string

If the resource is BigQuery, the BigQuery table ID.
fullResource

string

The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name
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.
sensitivityScore

object (SensitivityScore)

The sensitivity score of this table.
dataRiskLevel

object (DataRiskLevel)

The data risk level of this table.
predictedInfoTypes[]

object (InfoTypeSummary)

The infoTypes predicted from this table's data.
otherInfoTypes[]

object (OtherInfoTypeSummary)

Other infoTypes found in this table's data.
configSnapshot

object (DataProfileConfigSnapshot)

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

string (Timestamp format)

The time when this table 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".
expirationTime

string (Timestamp format)

Optional. The time when this table expires.

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".
scannedColumnCount

string (int64 format)

The number of columns profiled in the table.
failedColumnCount

string (int64 format)

The number of columns skipped in the table because of an error.
tableSizeBytes

string (int64 format)

The size of the table when the profile was generated.
rowCount

string (int64 format)

Number of rows in the table when the profile was generated. This will not be populated for BigLake tables.
encryptionStatus

enum (EncryptionStatus)

How the table is encrypted.
resourceVisibility

enum (ResourceVisibility)

How broadly a resource has been shared.
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".
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" }.
createTime

string (Timestamp format)

The time at which the table was 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".

DataSourceType

Message used to identify the type of resource being profiled.

JSON representation 
{
  "dataSource": string
}
Fields
dataSource

string

Output only. An identifying string to the type of resource being profiled. Current values: google/bigquery/table, google/project

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.

DataProfileConfigSnapshot

Snapshot of the configurations used to generate the profile.

JSON representation 
{
  "inspectConfig": {
    object (InspectConfig)
  },
  "dataProfileJob": {
    object (DataProfileJobConfig)
  },
  "discoveryConfig": {
    object (DiscoveryConfig)
  },
  "inspectTemplateName": string,
  "inspectTemplateModifiedTime": string
}
Fields
inspectConfig

object (InspectConfig)

A copy of the inspection config used to generate this profile. This is a copy of the inspectTemplate specified in DataProfileJobConfig.
dataProfileJob
(deprecated)

object (DataProfileJobConfig)

A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will.
discoveryConfig

object (DiscoveryConfig)

A copy of the configuration used to generate this profile.
inspectTemplateName

string

Name of the inspection template used to generate this profile
inspectTemplateModifiedTime

string (Timestamp format)

Timestamp when the template was 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".

DataProfileJobConfig

Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project.

The generated data profiles are retained according to the data retention policy.

JSON representation 
{
  "location": {
    object (DataProfileLocation)
  },
  "projectId": string,
  "inspectTemplates": [
    string
  ],
  "dataProfileActions": [
    {
      object (DataProfileAction)
    }
  ]
}
Fields
location

object (DataProfileLocation)

The data to scan.
projectId

string

The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.
inspectTemplates[]

string

Detection logic for profile generation.

Not all template features are used by profiles. FindingLimits, includeQuote and excludeInfoTypes have no impact on data profiling.

Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned.

For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.
dataProfileActions[]

object (DataProfileAction)

Actions to execute at the completion of the job.

DataProfileLocation

The data that will be profiled.

JSON representation 
{

  // Union field location can be only one of the following:
  "organizationId": string,
  "folderId": string
  // End of list of possible types for union field location.
}
Fields
Union field location. The location to be scanned. location can be only one of the following:
organizationId

string (int64 format)

The ID of an organization to scan.
folderId

string (int64 format)

The ID of the Folder within an organization to scan.

EncryptionStatus

How a resource is encrypted.

Enums
ENCRYPTION_STATUS_UNSPECIFIED Unused.
ENCRYPTION_GOOGLE_MANAGED Google manages server-side encryption keys on your behalf.
ENCRYPTION_CUSTOMER_MANAGED Customer provides the key.

ResourceVisibility

How broadly the data in the resource has been shared. New items may be added over time. A higher number means more restricted.

Enums
RESOURCE_VISIBILITY_UNSPECIFIED Unused.
RESOURCE_VISIBILITY_PUBLIC Visible to any user.
RESOURCE_VISIBILITY_RESTRICTED Visible only to specific users.

Methods

get

 Gets a table data profile.

list

 Lists table data profiles for an organization.