Class ColumnDataProfile (3.45.0)

public final class ColumnDataProfile extends GeneratedMessageV3 implements ColumnDataProfileOrBuilder

The profile for a scanned column within a table.

Protobuf type google.privacy.dlp.v2.ColumnDataProfile

Static Fields

COLUMN_FIELD_NUMBER

public static final int COLUMN_FIELD_NUMBER
Field Value
TypeDescription
int

COLUMN_INFO_TYPE_FIELD_NUMBER

public static final int COLUMN_INFO_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

COLUMN_TYPE_FIELD_NUMBER

public static final int COLUMN_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

DATASET_ID_FIELD_NUMBER

public static final int DATASET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DATASET_LOCATION_FIELD_NUMBER

public static final int DATASET_LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

DATASET_PROJECT_ID_FIELD_NUMBER

public static final int DATASET_PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_RISK_LEVEL_FIELD_NUMBER

public static final int DATA_RISK_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

ESTIMATED_NULL_PERCENTAGE_FIELD_NUMBER

public static final int ESTIMATED_NULL_PERCENTAGE_FIELD_NUMBER
Field Value
TypeDescription
int

ESTIMATED_UNIQUENESS_SCORE_FIELD_NUMBER

public static final int ESTIMATED_UNIQUENESS_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

FREE_TEXT_SCORE_FIELD_NUMBER

public static final int FREE_TEXT_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OTHER_MATCHES_FIELD_NUMBER

public static final int OTHER_MATCHES_FIELD_NUMBER
Field Value
TypeDescription
int

POLICY_STATE_FIELD_NUMBER

public static final int POLICY_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

PROFILE_LAST_GENERATED_FIELD_NUMBER

public static final int PROFILE_LAST_GENERATED_FIELD_NUMBER
Field Value
TypeDescription
int

PROFILE_STATUS_FIELD_NUMBER

public static final int PROFILE_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

SENSITIVITY_SCORE_FIELD_NUMBER

public static final int SENSITIVITY_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_DATA_PROFILE_FIELD_NUMBER

public static final int TABLE_DATA_PROFILE_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_FULL_RESOURCE_FIELD_NUMBER

public static final int TABLE_FULL_RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_ID_FIELD_NUMBER

public static final int TABLE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ColumnDataProfile getDefaultInstance()
Returns
TypeDescription
ColumnDataProfile

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ColumnDataProfile.Builder newBuilder()
Returns
TypeDescription
ColumnDataProfile.Builder

newBuilder(ColumnDataProfile prototype)

public static ColumnDataProfile.Builder newBuilder(ColumnDataProfile prototype)
Parameter
NameDescription
prototypeColumnDataProfile
Returns
TypeDescription
ColumnDataProfile.Builder

parseDelimitedFrom(InputStream input)

public static ColumnDataProfile parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnDataProfile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ColumnDataProfile parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ColumnDataProfile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ColumnDataProfile parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ColumnDataProfile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ColumnDataProfile parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnDataProfile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ColumnDataProfile parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnDataProfile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ColumnDataProfile parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ColumnDataProfile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnDataProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ColumnDataProfile> parser()
Returns
TypeDescription
Parser<ColumnDataProfile>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getColumn()

public String getColumn()

The name of the column.

string column = 6;

Returns
TypeDescription
String

The column.

getColumnBytes()

public ByteString getColumnBytes()

The name of the column.

string column = 6;

Returns
TypeDescription
ByteString

The bytes for column.

getColumnInfoType()

public InfoTypeSummary getColumnInfoType()

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.

.google.privacy.dlp.v2.InfoTypeSummary column_info_type = 9;

Returns
TypeDescription
InfoTypeSummary

The columnInfoType.

getColumnInfoTypeOrBuilder()

public InfoTypeSummaryOrBuilder getColumnInfoTypeOrBuilder()

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.

.google.privacy.dlp.v2.InfoTypeSummary column_info_type = 9;

Returns
TypeDescription
InfoTypeSummaryOrBuilder

getColumnType()

public ColumnDataProfile.ColumnDataType getColumnType()

The data type of a given column.

.google.privacy.dlp.v2.ColumnDataProfile.ColumnDataType column_type = 14;

Returns
TypeDescription
ColumnDataProfile.ColumnDataType

The columnType.

getColumnTypeValue()

public int getColumnTypeValue()

The data type of a given column.

.google.privacy.dlp.v2.ColumnDataProfile.ColumnDataType column_type = 14;

Returns
TypeDescription
int

The enum numeric value on the wire for columnType.

getDataRiskLevel()

public DataRiskLevel getDataRiskLevel()

The data risk level for this column.

.google.privacy.dlp.v2.DataRiskLevel data_risk_level = 8;

Returns
TypeDescription
DataRiskLevel

The dataRiskLevel.

getDataRiskLevelOrBuilder()

public DataRiskLevelOrBuilder getDataRiskLevelOrBuilder()

The data risk level for this column.

.google.privacy.dlp.v2.DataRiskLevel data_risk_level = 8;

Returns
TypeDescription
DataRiskLevelOrBuilder

getDatasetId()

public String getDatasetId()

The BigQuery dataset ID.

string dataset_id = 21;

Returns
TypeDescription
String

The datasetId.

getDatasetIdBytes()

public ByteString getDatasetIdBytes()

The BigQuery dataset ID.

string dataset_id = 21;

Returns
TypeDescription
ByteString

The bytes for datasetId.

getDatasetLocation()

public String getDatasetLocation()

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

string dataset_location = 20;

Returns
TypeDescription
String

The datasetLocation.

getDatasetLocationBytes()

public ByteString getDatasetLocationBytes()

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

string dataset_location = 20;

Returns
TypeDescription
ByteString

The bytes for datasetLocation.

getDatasetProjectId()

public String getDatasetProjectId()

The Google Cloud project ID that owns the profiled resource.

string dataset_project_id = 19;

Returns
TypeDescription
String

The datasetProjectId.

getDatasetProjectIdBytes()

public ByteString getDatasetProjectIdBytes()

The Google Cloud project ID that owns the profiled resource.

string dataset_project_id = 19;

Returns
TypeDescription
ByteString

The bytes for datasetProjectId.

getDefaultInstanceForType()

public ColumnDataProfile getDefaultInstanceForType()
Returns
TypeDescription
ColumnDataProfile

getEstimatedNullPercentage()

public NullPercentageLevel getEstimatedNullPercentage()

Approximate percentage of entries being null in the column.

.google.privacy.dlp.v2.NullPercentageLevel estimated_null_percentage = 23;

Returns
TypeDescription
NullPercentageLevel

The estimatedNullPercentage.

getEstimatedNullPercentageValue()

public int getEstimatedNullPercentageValue()

Approximate percentage of entries being null in the column.

.google.privacy.dlp.v2.NullPercentageLevel estimated_null_percentage = 23;

Returns
TypeDescription
int

The enum numeric value on the wire for estimatedNullPercentage.

getEstimatedUniquenessScore()

public UniquenessScoreLevel getEstimatedUniquenessScore()

Approximate uniqueness of the column.

.google.privacy.dlp.v2.UniquenessScoreLevel estimated_uniqueness_score = 24;

Returns
TypeDescription
UniquenessScoreLevel

The estimatedUniquenessScore.

getEstimatedUniquenessScoreValue()

public int getEstimatedUniquenessScoreValue()

Approximate uniqueness of the column.

.google.privacy.dlp.v2.UniquenessScoreLevel estimated_uniqueness_score = 24;

Returns
TypeDescription
int

The enum numeric value on the wire for estimatedUniquenessScore.

getFreeTextScore()

public double getFreeTextScore()

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.

double free_text_score = 13;

Returns
TypeDescription
double

The freeTextScore.

getName()

public String getName()

The name of the profile.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the profile.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOtherMatches(int index)

public OtherInfoTypeSummary getOtherMatches(int index)

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

repeated .google.privacy.dlp.v2.OtherInfoTypeSummary other_matches = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
OtherInfoTypeSummary

getOtherMatchesCount()

public int getOtherMatchesCount()

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

repeated .google.privacy.dlp.v2.OtherInfoTypeSummary other_matches = 10;

Returns
TypeDescription
int

getOtherMatchesList()

public List<OtherInfoTypeSummary> getOtherMatchesList()

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

repeated .google.privacy.dlp.v2.OtherInfoTypeSummary other_matches = 10;

Returns
TypeDescription
List<OtherInfoTypeSummary>

getOtherMatchesOrBuilder(int index)

public OtherInfoTypeSummaryOrBuilder getOtherMatchesOrBuilder(int index)

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

repeated .google.privacy.dlp.v2.OtherInfoTypeSummary other_matches = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
OtherInfoTypeSummaryOrBuilder

getOtherMatchesOrBuilderList()

public List<? extends OtherInfoTypeSummaryOrBuilder> getOtherMatchesOrBuilderList()

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

repeated .google.privacy.dlp.v2.OtherInfoTypeSummary other_matches = 10;

Returns
TypeDescription
List<? extends com.google.privacy.dlp.v2.OtherInfoTypeSummaryOrBuilder>

getParserForType()

public Parser<ColumnDataProfile> getParserForType()
Returns
TypeDescription
Parser<ColumnDataProfile>
Overrides

getPolicyState()

public ColumnDataProfile.ColumnPolicyState getPolicyState()

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

.google.privacy.dlp.v2.ColumnDataProfile.ColumnPolicyState policy_state = 15;

Returns
TypeDescription
ColumnDataProfile.ColumnPolicyState

The policyState.

getPolicyStateValue()

public int getPolicyStateValue()

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

.google.privacy.dlp.v2.ColumnDataProfile.ColumnPolicyState policy_state = 15;

Returns
TypeDescription
int

The enum numeric value on the wire for policyState.

getProfileLastGenerated()

public Timestamp getProfileLastGenerated()

The last time the profile was generated.

.google.protobuf.Timestamp profile_last_generated = 3;

Returns
TypeDescription
Timestamp

The profileLastGenerated.

getProfileLastGeneratedOrBuilder()

public TimestampOrBuilder getProfileLastGeneratedOrBuilder()

The last time the profile was generated.

.google.protobuf.Timestamp profile_last_generated = 3;

Returns
TypeDescription
TimestampOrBuilder

getProfileStatus()

public ProfileStatus getProfileStatus()

Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

.google.privacy.dlp.v2.ProfileStatus profile_status = 17;

Returns
TypeDescription
ProfileStatus

The profileStatus.

getProfileStatusOrBuilder()

public ProfileStatusOrBuilder getProfileStatusOrBuilder()

Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

.google.privacy.dlp.v2.ProfileStatus profile_status = 17;

Returns
TypeDescription