Represents an InspectConfig.
Package
@google-cloud/dlpConstructors
(constructor)(properties)
constructor(properties?: google.privacy.dlp.v2.IInspectConfig);Constructs a new InspectConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInspectConfig
Properties to set |
Properties
contentOptions
public contentOptions: google.privacy.dlp.v2.ContentOption[];InspectConfig contentOptions.
customInfoTypes
public customInfoTypes: google.privacy.dlp.v2.ICustomInfoType[];InspectConfig customInfoTypes.
excludeInfoTypes
public excludeInfoTypes: boolean;InspectConfig excludeInfoTypes.
includeQuote
public includeQuote: boolean;InspectConfig includeQuote.
infoTypes
public infoTypes: google.privacy.dlp.v2.IInfoType[];InspectConfig infoTypes.
limits
public limits?: (google.privacy.dlp.v2.InspectConfig.IFindingLimits|null);InspectConfig limits.
minLikelihood
public minLikelihood: (google.privacy.dlp.v2.Likelihood|keyof typeof google.privacy.dlp.v2.Likelihood);InspectConfig minLikelihood.
minLikelihoodPerInfoType
public minLikelihoodPerInfoType: google.privacy.dlp.v2.InspectConfig.IInfoTypeLikelihood[];InspectConfig minLikelihoodPerInfoType.
ruleSet
public ruleSet: google.privacy.dlp.v2.IInspectionRuleSet[];InspectConfig ruleSet.
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 | |
|---|---|
| Name | Description |
properties |
IInspectConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
IInspectConfig
InspectConfig 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.IInspectConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified InspectConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInspectConfig
InspectConfig 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.InspectConfig;Creates an InspectConfig 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 |
InspectConfig |
InspectConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for InspectConfig
| 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 InspectConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
InspectConfig
InspectConfig |
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 InspectConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|