Class protos.google.privacy.dlp.v2.InspectConfig

Represents an InspectConfig.

Package

@google-cloud/dlp!

Constructors

(constructor)(properties)

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

Constructs a new InspectConfig.

Parameter
TypeNameDescription
IInspectConfigproperties

Properties to set

Properties

contentOptions

public contentOptions: google.privacy.dlp.v2.ContentOption[];

InspectConfig contentOptions.

Property Value
TypeDescription
google.privacy.dlp.v2.ContentOption[]

customInfoTypes

public customInfoTypes: google.privacy.dlp.v2.ICustomInfoType[];

InspectConfig customInfoTypes.

Property Value
TypeDescription
google.privacy.dlp.v2.ICustomInfoType[]

excludeInfoTypes

public excludeInfoTypes: boolean;

InspectConfig excludeInfoTypes.

Property Value
TypeDescription
boolean

includeQuote

public includeQuote: boolean;

InspectConfig includeQuote.

Property Value
TypeDescription
boolean

infoTypes

public infoTypes: google.privacy.dlp.v2.IInfoType[];

InspectConfig infoTypes.

Property Value
TypeDescription
google.privacy.dlp.v2.IInfoType[]

limits

public limits?: (google.privacy.dlp.v2.InspectConfig.IFindingLimits|null);

InspectConfig limits.

Property Value
TypeDescription
(google.privacy.dlp.v2.InspectConfig.IFindingLimits|null)

minLikelihood

public minLikelihood: (google.privacy.dlp.v2.Likelihood|keyof typeof google.privacy.dlp.v2.Likelihood);

InspectConfig minLikelihood.

Property Value
TypeDescription
(google.privacy.dlp.v2.Likelihood|keyof typeof google.privacy.dlp.v2.Likelihood)

ruleSet

public ruleSet: google.privacy.dlp.v2.IInspectionRuleSet[];

InspectConfig ruleSet.

Property Value
TypeDescription
google.privacy.dlp.v2.IInspectionRuleSet[]

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IInspectConfig): google.privacy.dlp.v2.InspectConfig;

Creates a new InspectConfig instance using the specified properties.

Parameter
TypeNameDescription
IInspectConfigproperties

Properties to set

Returns
TypeDescription
google.privacy.dlp.v2.InspectConfig

InspectConfig instance

decode(reader, length)

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

Decodes an InspectConfig message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.privacy.dlp.v2.InspectConfig

InspectConfig

decodeDelimited(reader)

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

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.privacy.dlp.v2.InspectConfig

InspectConfig

encode(message, writer)

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

Encodes the specified InspectConfig message. Does not implicitly messages.

Parameters
TypeNameDescription
IInspectConfigmessage

InspectConfig message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
IInspectConfigmessage

InspectConfig message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.privacy.dlp.v2.InspectConfig;

Creates an InspectConfig message from a plain object. Also converts values to their respective internal types.

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.privacy.dlp.v2.InspectConfig

InspectConfig

toJSON()

public toJSON(): { [k: string]: any };

Converts this InspectConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.privacy.dlp.v2.InspectConfigmessage

InspectConfig

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an InspectConfig message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not