Class protos.google.privacy.dlp.v2.PrivacyMetric (5.0.0)

Represents a PrivacyMetric.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new PrivacyMetric.

Parameter
NameDescription
properties IPrivacyMetric

Properties to set

Properties

categoricalStatsConfig

public categoricalStatsConfig?: (google.privacy.dlp.v2.PrivacyMetric.ICategoricalStatsConfig|null);

PrivacyMetric categoricalStatsConfig.

deltaPresenceEstimationConfig

public deltaPresenceEstimationConfig?: (google.privacy.dlp.v2.PrivacyMetric.IDeltaPresenceEstimationConfig|null);

PrivacyMetric deltaPresenceEstimationConfig.

kAnonymityConfig

public kAnonymityConfig?: (google.privacy.dlp.v2.PrivacyMetric.IKAnonymityConfig|null);

PrivacyMetric kAnonymityConfig.

kMapEstimationConfig

public kMapEstimationConfig?: (google.privacy.dlp.v2.PrivacyMetric.IKMapEstimationConfig|null);

PrivacyMetric kMapEstimationConfig.

lDiversityConfig

public lDiversityConfig?: (google.privacy.dlp.v2.PrivacyMetric.ILDiversityConfig|null);

PrivacyMetric lDiversityConfig.

numericalStatsConfig

public numericalStatsConfig?: (google.privacy.dlp.v2.PrivacyMetric.INumericalStatsConfig|null);

PrivacyMetric numericalStatsConfig.

type

public type?: ("numericalStatsConfig"|"categoricalStatsConfig"|"kAnonymityConfig"|"lDiversityConfig"|"kMapEstimationConfig"|"deltaPresenceEstimationConfig");

PrivacyMetric type.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IPrivacyMetric): google.privacy.dlp.v2.PrivacyMetric;

Creates a new PrivacyMetric instance using the specified properties.

Parameter
NameDescription
properties IPrivacyMetric

Properties to set

Returns
TypeDescription
PrivacyMetric

PrivacyMetric instance

decode(reader, length)

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

Decodes a PrivacyMetric message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
PrivacyMetric

PrivacyMetric

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
PrivacyMetric

PrivacyMetric

encode(message, writer)

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

Encodes the specified PrivacyMetric message. Does not implicitly messages.

Parameters
NameDescription
message IPrivacyMetric

PrivacyMetric message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IPrivacyMetric

PrivacyMetric message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

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

Plain object

Returns
TypeDescription
PrivacyMetric

PrivacyMetric

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PrivacyMetric

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this PrivacyMetric to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message PrivacyMetric

PrivacyMetric

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a PrivacyMetric message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not