REST Resource: projects.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 of 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".

Methods

delete

Delete a TableDataProfile.

get

Gets a table data profile.

list

Lists table data profiles for an organization.