Class ColumnDataProfile (3.15.2)

ColumnDataProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The profile for a scanned column within a table.

Attributes

NameDescription
name str
The name of the profile.
profile_status google.cloud.dlp_v2.types.ProfileStatus
Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.
state google.cloud.dlp_v2.types.ColumnDataProfile.State
State of a profile.
profile_last_generated google.protobuf.timestamp_pb2.Timestamp
The last time the profile was generated.
table_data_profile str
The resource name of the table data profile.
table_full_resource str
The resource name of the table this column is within.
dataset_project_id str
The Google Cloud project ID that owns the BigQuery dataset.
dataset_location str
The BigQuery location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.
dataset_id str
The BigQuery dataset ID.
table_id str
The BigQuery table ID.
column str
The name of the column.
sensitivity_score google.cloud.dlp_v2.types.SensitivityScore
The sensitivity of this column.
data_risk_level google.cloud.dlp_v2.types.DataRiskLevel
The data risk level for this column.
column_info_type google.cloud.dlp_v2.types.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.
other_matches MutableSequence[google.cloud.dlp_v2.types.OtherInfoTypeSummary]
Other types found within this column. List will be unordered.
estimated_null_percentage google.cloud.dlp_v2.types.NullPercentageLevel
Approximate percentage of entries being null in the column.
estimated_uniqueness_score google.cloud.dlp_v2.types.UniquenessScoreLevel
Approximate uniqueness of the column.
free_text_score float
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.
column_type google.cloud.dlp_v2.types.ColumnDataProfile.ColumnDataType
The data type of a given column.
policy_state google.cloud.dlp_v2.types.ColumnDataProfile.ColumnPolicyState
Indicates if a policy tag has been applied to the column.

Classes

ColumnDataType

ColumnDataType(value)

Data types of the data in a column. Types may be added over time.

Values: COLUMN_DATA_TYPE_UNSPECIFIED (0): Invalid type. TYPE_INT64 (1): Encoded as a string in decimal format. TYPE_BOOL (2): Encoded as a boolean "false" or "true". TYPE_FLOAT64 (3): Encoded as a number, or string "NaN", "Infinity" or "-Infinity". TYPE_STRING (4): Encoded as a string value. TYPE_BYTES (5): Encoded as a base64 string per RFC 4648, section 4. TYPE_TIMESTAMP (6): Encoded as an RFC 3339 timestamp with mandatory "Z" time zone string: 1985-04-12T23:20:50.52Z TYPE_DATE (7): Encoded as RFC 3339 full-date format string: 1985-04-12 TYPE_TIME (8): Encoded as RFC 3339 partial-time format string: 23:20:50.52 TYPE_DATETIME (9): Encoded as RFC 3339 full-date "T" partial-time: 1985-04-12T23:20:50.52 TYPE_GEOGRAPHY (10): Encoded as WKT TYPE_NUMERIC (11): Encoded as a decimal string. TYPE_RECORD (12): Container of ordered fields, each with a type and field name. TYPE_BIGNUMERIC (13): Decimal type. TYPE_JSON (14): Json type.

ColumnPolicyState

ColumnPolicyState(value)

The possible policy states for a column.

Values: COLUMN_POLICY_STATE_UNSPECIFIED (0): No policy tags. COLUMN_POLICY_TAGGED (1): Column has policy tag applied.

State

State(value)

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

Values: STATE_UNSPECIFIED (0): Unused. RUNNING (1): The profile is currently running. Once a profile has finished it will transition to DONE. DONE (2): The profile is no longer generating. If profile_status.status.code is 0, the profile succeeded, otherwise, it failed.