Class protos.google.privacy.dlp.v2.CustomInfoType.Dictionary (5.11.0)

Represents a Dictionary.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new Dictionary.

Parameter
Name Description
properties IDictionary

Properties to set

Properties

cloudStoragePath

public cloudStoragePath?: (google.privacy.dlp.v2.ICloudStoragePath|null);

Dictionary cloudStoragePath.

source

public source?: ("wordList"|"cloudStoragePath");

Dictionary source.

wordList

public wordList?: (google.privacy.dlp.v2.CustomInfoType.Dictionary.IWordList|null);

Dictionary wordList.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.CustomInfoType.IDictionary): google.privacy.dlp.v2.CustomInfoType.Dictionary;

Creates a new Dictionary instance using the specified properties.

Parameter
Name Description
properties IDictionary

Properties to set

Returns
Type Description
Dictionary

Dictionary instance

decode(reader, length)

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

Decodes a Dictionary 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
Dictionary

Dictionary

decodeDelimited(reader)

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

Decodes a Dictionary message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Dictionary

Dictionary

encode(message, writer)

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

Encodes the specified Dictionary message. Does not implicitly messages.

Parameters
Name Description
message IDictionary

Dictionary 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.CustomInfoType.IDictionary, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IDictionary

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

Creates a Dictionary 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
Dictionary

Dictionary

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Dictionary

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Dictionary

Dictionary

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 Dictionary 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