Represents a ColumnDataProfile.
Package
@google-cloud/dlpConstructors
(constructor)(properties)
constructor(properties?: google.privacy.dlp.v2.IColumnDataProfile);Constructs a new ColumnDataProfile.
| Parameter | |
|---|---|
| Name | Description |
properties |
IColumnDataProfile
Properties to set |
Properties
column
public column: string;ColumnDataProfile column.
columnInfoType
public columnInfoType?: (google.privacy.dlp.v2.IInfoTypeSummary|null);ColumnDataProfile columnInfoType.
columnType
public columnType: (google.privacy.dlp.v2.ColumnDataProfile.ColumnDataType|keyof typeof google.privacy.dlp.v2.ColumnDataProfile.ColumnDataType);ColumnDataProfile columnType.
dataRiskLevel
public dataRiskLevel?: (google.privacy.dlp.v2.IDataRiskLevel|null);ColumnDataProfile dataRiskLevel.
datasetId
public datasetId: string;ColumnDataProfile datasetId.
datasetLocation
public datasetLocation: string;ColumnDataProfile datasetLocation.
datasetProjectId
public datasetProjectId: string;ColumnDataProfile datasetProjectId.
estimatedNullPercentage
public estimatedNullPercentage: (google.privacy.dlp.v2.NullPercentageLevel|keyof typeof google.privacy.dlp.v2.NullPercentageLevel);ColumnDataProfile estimatedNullPercentage.
estimatedUniquenessScore
public estimatedUniquenessScore: (google.privacy.dlp.v2.UniquenessScoreLevel|keyof typeof google.privacy.dlp.v2.UniquenessScoreLevel);ColumnDataProfile estimatedUniquenessScore.
freeTextScore
public freeTextScore: number;ColumnDataProfile freeTextScore.
name
public name: string;ColumnDataProfile name.
otherMatches
public otherMatches: google.privacy.dlp.v2.IOtherInfoTypeSummary[];ColumnDataProfile otherMatches.
policyState
public policyState: (google.privacy.dlp.v2.ColumnDataProfile.ColumnPolicyState|keyof typeof google.privacy.dlp.v2.ColumnDataProfile.ColumnPolicyState);ColumnDataProfile policyState.
profileLastGenerated
public profileLastGenerated?: (google.protobuf.ITimestamp|null);ColumnDataProfile profileLastGenerated.
profileStatus
public profileStatus?: (google.privacy.dlp.v2.IProfileStatus|null);ColumnDataProfile profileStatus.
sensitivityScore
public sensitivityScore?: (google.privacy.dlp.v2.ISensitivityScore|null);ColumnDataProfile sensitivityScore.
state
public state: (google.privacy.dlp.v2.ColumnDataProfile.State|keyof typeof google.privacy.dlp.v2.ColumnDataProfile.State);ColumnDataProfile state.
tableDataProfile
public tableDataProfile: string;ColumnDataProfile tableDataProfile.
tableFullResource
public tableFullResource: string;ColumnDataProfile tableFullResource.
tableId
public tableId: string;ColumnDataProfile tableId.
Methods
create(properties)
public static create(properties?: google.privacy.dlp.v2.IColumnDataProfile): google.privacy.dlp.v2.ColumnDataProfile;Creates a new ColumnDataProfile instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IColumnDataProfile
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ColumnDataProfile |
ColumnDataProfile instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.ColumnDataProfile;Decodes a ColumnDataProfile message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
ColumnDataProfile |
ColumnDataProfile |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.ColumnDataProfile;Decodes a ColumnDataProfile message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ColumnDataProfile |
ColumnDataProfile |
encode(message, writer)
public static encode(message: google.privacy.dlp.v2.IColumnDataProfile, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ColumnDataProfile message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IColumnDataProfile
ColumnDataProfile message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.privacy.dlp.v2.IColumnDataProfile, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ColumnDataProfile message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IColumnDataProfile
ColumnDataProfile message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.privacy.dlp.v2.ColumnDataProfile;Creates a ColumnDataProfile message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
ColumnDataProfile |
ColumnDataProfile |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ColumnDataProfile
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ColumnDataProfile to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.privacy.dlp.v2.ColumnDataProfile, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ColumnDataProfile message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ColumnDataProfile
ColumnDataProfile |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a ColumnDataProfile message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|