REST Resource: projects.locations.columnDataProfiles

Resource: ColumnDataProfile

The profile for a scanned column within a table.

JSON representation 
{
  "name": string,
  "profileStatus": {
    object (ProfileStatus)
  },
  "state": enum (State),
  "profileLastGenerated": string,
  "tableDataProfile": string,
  "tableFullResource": string,
  "datasetProjectId": string,
  "datasetLocation": string,
  "datasetId": string,
  "tableId": string,
  "column": string,
  "sensitivityScore": {
    object (SensitivityScore)
  },
  "dataRiskLevel": {
    object (DataRiskLevel)
  },
  "columnInfoType": {
    object (InfoTypeSummary)
  },
  "otherMatches": [
    {
      object (OtherInfoTypeSummary)
    }
  ],
  "estimatedNullPercentage": enum (NullPercentageLevel),
  "estimatedUniquenessScore": enum (UniquenessScoreLevel),
  "freeTextScore": number,
  "columnType": enum (ColumnDataType),
  "policyState": enum (ColumnPolicyState)
}
Fields
name

string

The name of 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 use 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".
tableDataProfile

string

The resource name of the table data profile.
tableFullResource

string

The resource name of the resource this column is within.
datasetProjectId

string

The Google Cloud project ID that owns the profiled resource.
datasetLocation

string

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

string

The BigQuery dataset ID, if the resource profiled is a BigQuery table.
tableId

string

The table ID.
column

string

The name of the column.
sensitivityScore

object (SensitivityScore)

The sensitivity of this column.
dataRiskLevel

object (DataRiskLevel)

The data risk level for this column.
columnInfoType

object (InfoTypeSummary)

If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.
otherMatches[]

object (OtherInfoTypeSummary)

Other types found within this column. List will be unordered.
estimatedNullPercentage

enum (NullPercentageLevel)

Approximate percentage of entries being null in the column.
estimatedUniquenessScore

enum (UniquenessScoreLevel)

Approximate uniqueness of the column.
freeTextScore

number

The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.
columnType

enum (ColumnDataType)

The data type of a given column.
policyState

enum (ColumnPolicyState)

Indicates if a policy tag has been applied to the column.

Methods

get

 Gets a column data profile.

list

 Lists column data profiles for an organization.