Class protos.google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig.TaggedField (5.3.0)

Represents a TaggedField.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

constructor(properties?: google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig.ITaggedField);

Constructs a new TaggedField.

Parameter
Name Description
properties ITaggedField

Properties to set

Properties

customTag

public customTag?: (string|null);

TaggedField customTag.

field

public field?: (google.privacy.dlp.v2.IFieldId|null);

TaggedField field.

inferred

public inferred?: (google.protobuf.IEmpty|null);

TaggedField inferred.

infoType

public infoType?: (google.privacy.dlp.v2.IInfoType|null);

TaggedField infoType.

tag

public tag?: ("infoType"|"customTag"|"inferred");

TaggedField tag.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig.ITaggedField): google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig.TaggedField;

Creates a new TaggedField instance using the specified properties.

Parameter
Name Description
properties ITaggedField

Properties to set

Returns
Type Description
TaggedField

TaggedField instance

decode(reader, length)

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

Decodes a TaggedField 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
TaggedField

TaggedField

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TaggedField

TaggedField

encode(message, writer)

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

Encodes the specified TaggedField message. Does not implicitly messages.

Parameters
Name Description
message ITaggedField

TaggedField 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.PrivacyMetric.KMapEstimationConfig.ITaggedField, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ITaggedField

TaggedField 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.PrivacyMetric.KMapEstimationConfig.TaggedField;

Creates a TaggedField 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
TaggedField

TaggedField

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TaggedField

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message TaggedField

TaggedField

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 a TaggedField 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