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

Represents a CharsToIgnore.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new CharsToIgnore.

Parameter
Name Description
properties ICharsToIgnore

Properties to set

Properties

characters

public characters?: ("charactersToSkip"|"commonCharactersToIgnore");

CharsToIgnore characters.

charactersToSkip

public charactersToSkip?: (string|null);

CharsToIgnore charactersToSkip.

commonCharactersToIgnore

public commonCharactersToIgnore?: (google.privacy.dlp.v2.CharsToIgnore.CommonCharsToIgnore|keyof typeof google.privacy.dlp.v2.CharsToIgnore.CommonCharsToIgnore|null);

CharsToIgnore commonCharactersToIgnore.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.ICharsToIgnore): google.privacy.dlp.v2.CharsToIgnore;

Creates a new CharsToIgnore instance using the specified properties.

Parameter
Name Description
properties ICharsToIgnore

Properties to set

Returns
Type Description
CharsToIgnore

CharsToIgnore instance

decode(reader, length)

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

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

CharsToIgnore

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CharsToIgnore

CharsToIgnore

encode(message, writer)

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

Encodes the specified CharsToIgnore message. Does not implicitly messages.

Parameters
Name Description
message ICharsToIgnore

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

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

Parameters
Name Description
message ICharsToIgnore

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

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

CharsToIgnore

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CharsToIgnore

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CharsToIgnore

CharsToIgnore

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