Class protos.google.privacy.dlp.v2.InfoTypeDescription (5.11.0)

Represents an InfoTypeDescription.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

constructor(properties?: google.privacy.dlp.v2.IInfoTypeDescription);

Constructs a new InfoTypeDescription.

Parameter
Name Description
properties IInfoTypeDescription

Properties to set

Properties

categories

public categories: google.privacy.dlp.v2.IInfoTypeCategory[];

InfoTypeDescription categories.

description

public description: string;

InfoTypeDescription description.

displayName

public displayName: string;

InfoTypeDescription displayName.

name

public name: string;

InfoTypeDescription name.

sensitivityScore

public sensitivityScore?: (google.privacy.dlp.v2.ISensitivityScore|null);

InfoTypeDescription sensitivityScore.

supportedBy

public supportedBy: google.privacy.dlp.v2.InfoTypeSupportedBy[];

InfoTypeDescription supportedBy.

versions

public versions: google.privacy.dlp.v2.IVersionDescription[];

InfoTypeDescription versions.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IInfoTypeDescription): google.privacy.dlp.v2.InfoTypeDescription;

Creates a new InfoTypeDescription instance using the specified properties.

Parameter
Name Description
properties IInfoTypeDescription

Properties to set

Returns
Type Description
InfoTypeDescription

InfoTypeDescription instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.InfoTypeDescription;

Decodes an InfoTypeDescription 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
InfoTypeDescription

InfoTypeDescription

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.InfoTypeDescription;

Decodes an InfoTypeDescription message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
InfoTypeDescription

InfoTypeDescription

encode(message, writer)

public static encode(message: google.privacy.dlp.v2.IInfoTypeDescription, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified InfoTypeDescription message. Does not implicitly messages.

Parameters
Name Description
message IInfoTypeDescription

InfoTypeDescription 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.IInfoTypeDescription, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified InfoTypeDescription message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IInfoTypeDescription

InfoTypeDescription 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.InfoTypeDescription;

Creates an InfoTypeDescription 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
InfoTypeDescription

InfoTypeDescription

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for InfoTypeDescription

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 InfoTypeDescription to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.privacy.dlp.v2.InfoTypeDescription, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an InfoTypeDescription message. Also converts values to other types if specified.

Parameters
Name Description
message InfoTypeDescription

InfoTypeDescription

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 an InfoTypeDescription message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not