Class protos.google.privacy.dlp.v2.AdjustmentRule (6.6.0)

Represents an AdjustmentRule.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new AdjustmentRule.

Parameter
Name Description
properties IAdjustmentRule

Properties to set

Properties

adjustByImageFindings

public adjustByImageFindings?: (google.privacy.dlp.v2.IAdjustByImageFindings|null);

AdjustmentRule adjustByImageFindings.

adjustByMatchingInfoTypes

public adjustByMatchingInfoTypes?: (google.privacy.dlp.v2.IAdjustByMatchingInfoTypes|null);

AdjustmentRule adjustByMatchingInfoTypes.

conditions

public conditions?: ("adjustByMatchingInfoTypes"|"adjustByImageFindings");

AdjustmentRule conditions.

likelihoodAdjustment

public likelihoodAdjustment?: (google.privacy.dlp.v2.CustomInfoType.DetectionRule.ILikelihoodAdjustment|null);

AdjustmentRule likelihoodAdjustment.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IAdjustmentRule): google.privacy.dlp.v2.AdjustmentRule;

Creates a new AdjustmentRule instance using the specified properties.

Parameter
Name Description
properties IAdjustmentRule

Properties to set

Returns
Type Description
AdjustmentRule

AdjustmentRule instance

decode(reader, length)

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

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

AdjustmentRule

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AdjustmentRule

AdjustmentRule

encode(message, writer)

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

Encodes the specified AdjustmentRule message. Does not implicitly messages.

Parameters
Name Description
message IAdjustmentRule

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

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

Parameters
Name Description
message IAdjustmentRule

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

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

AdjustmentRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AdjustmentRule

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AdjustmentRule

AdjustmentRule

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