Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.privacy.dlp.v2.ExclusionRule (4.2.0)

Represents an ExclusionRule.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new ExclusionRule.

Parameter

Name	Description
properties	`IExclusionRule` Properties to set

Properties

dictionary

public dictionary?: (google.privacy.dlp.v2.CustomInfoType.IDictionary|null);

ExclusionRule dictionary.

excludeInfoTypes

public excludeInfoTypes?: (google.privacy.dlp.v2.IExcludeInfoTypes|null);

ExclusionRule excludeInfoTypes.

matchingType

public matchingType: (google.privacy.dlp.v2.MatchingType|keyof typeof google.privacy.dlp.v2.MatchingType);

ExclusionRule matchingType.

regex

public regex?: (google.privacy.dlp.v2.CustomInfoType.IRegex|null);

ExclusionRule regex.

type

public type?: ("dictionary"|"regex"|"excludeInfoTypes");

ExclusionRule type.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IExclusionRule): google.privacy.dlp.v2.ExclusionRule;

Creates a new ExclusionRule instance using the specified properties.

Parameter

Name	Description
properties	`IExclusionRule` Properties to set

Returns

Type	Description
google.privacy.dlp.v2.ExclusionRule	ExclusionRule instance

decode(reader, length)

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

Decodes an ExclusionRule message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.privacy.dlp.v2.ExclusionRule	ExclusionRule

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.privacy.dlp.v2.ExclusionRule	ExclusionRule

encode(message, writer)

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

Encodes the specified ExclusionRule message. Does not implicitly messages.

Parameters

Name	Description
message	`IExclusionRule` ExclusionRule 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.IExclusionRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IExclusionRule` ExclusionRule 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.ExclusionRule;

Creates an ExclusionRule 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
google.privacy.dlp.v2.ExclusionRule	ExclusionRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ExclusionRule

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.privacy.dlp.v2.ExclusionRule` ExclusionRule
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 ExclusionRule 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