Represents a CustomInfoType.
Package
@google-cloud/dlpConstructors
(constructor)(properties)
constructor(properties?: google.privacy.dlp.v2.ICustomInfoType);Constructs a new CustomInfoType.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICustomInfoType
Properties to set |
Properties
detectionRules
public detectionRules: google.privacy.dlp.v2.CustomInfoType.IDetectionRule[];CustomInfoType detectionRules.
dictionary
public dictionary?: (google.privacy.dlp.v2.CustomInfoType.IDictionary|null);CustomInfoType dictionary.
exclusionType
public exclusionType: (google.privacy.dlp.v2.CustomInfoType.ExclusionType|keyof typeof google.privacy.dlp.v2.CustomInfoType.ExclusionType);CustomInfoType exclusionType.
infoType
public infoType?: (google.privacy.dlp.v2.IInfoType|null);CustomInfoType infoType.
likelihood
public likelihood: (google.privacy.dlp.v2.Likelihood|keyof typeof google.privacy.dlp.v2.Likelihood);CustomInfoType likelihood.
regex
public regex?: (google.privacy.dlp.v2.CustomInfoType.IRegex|null);CustomInfoType regex.
sensitivityScore
public sensitivityScore?: (google.privacy.dlp.v2.ISensitivityScore|null);CustomInfoType sensitivityScore.
storedType
public storedType?: (google.privacy.dlp.v2.IStoredType|null);CustomInfoType storedType.
surrogateType
public surrogateType?: (google.privacy.dlp.v2.CustomInfoType.ISurrogateType|null);CustomInfoType surrogateType.
type
public type?: ("dictionary"|"regex"|"surrogateType"|"storedType");CustomInfoType type.
Methods
create(properties)
public static create(properties?: google.privacy.dlp.v2.ICustomInfoType): google.privacy.dlp.v2.CustomInfoType;Creates a new CustomInfoType instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICustomInfoType
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CustomInfoType |
CustomInfoType instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.CustomInfoType;Decodes a CustomInfoType 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 |
CustomInfoType |
CustomInfoType |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.CustomInfoType;Decodes a CustomInfoType message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CustomInfoType |
CustomInfoType |
encode(message, writer)
public static encode(message: google.privacy.dlp.v2.ICustomInfoType, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CustomInfoType message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICustomInfoType
CustomInfoType 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.ICustomInfoType, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CustomInfoType message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICustomInfoType
CustomInfoType 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.CustomInfoType;Creates a CustomInfoType 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 |
CustomInfoType |
CustomInfoType |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CustomInfoType
| 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 CustomInfoType to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.privacy.dlp.v2.CustomInfoType, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CustomInfoType message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CustomInfoType
CustomInfoType |
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 CustomInfoType message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|