Class protos.google.privacy.dlp.v2.TransformationSummary

Represents a TransformationSummary.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new TransformationSummary.

Parameter
NameDescription
properties ITransformationSummary

Properties to set

Properties

field

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

TransformationSummary field.

fieldTransformations

public fieldTransformations: google.privacy.dlp.v2.IFieldTransformation[];

TransformationSummary fieldTransformations.

infoType

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

TransformationSummary infoType.

recordSuppress

public recordSuppress?: (google.privacy.dlp.v2.IRecordSuppression|null);

TransformationSummary recordSuppress.

results

public results: google.privacy.dlp.v2.TransformationSummary.ISummaryResult[];

TransformationSummary results.

transformation

public transformation?: (google.privacy.dlp.v2.IPrimitiveTransformation|null);

TransformationSummary transformation.

transformedBytes

public transformedBytes: (number|Long|string);

TransformationSummary transformedBytes.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.ITransformationSummary): google.privacy.dlp.v2.TransformationSummary;

Creates a new TransformationSummary instance using the specified properties.

Parameter
NameDescription
properties ITransformationSummary

Properties to set

Returns
TypeDescription
google.privacy.dlp.v2.TransformationSummary

TransformationSummary instance

decode(reader, length)

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

Decodes a TransformationSummary message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.privacy.dlp.v2.TransformationSummary

TransformationSummary

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.privacy.dlp.v2.TransformationSummary

TransformationSummary

encode(message, writer)

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

Encodes the specified TransformationSummary message. Does not implicitly messages.

Parameters
NameDescription
message ITransformationSummary

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

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

Parameters
NameDescription
message ITransformationSummary

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

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

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

Plain object

Returns
TypeDescription
google.privacy.dlp.v2.TransformationSummary

TransformationSummary

toJSON()

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

Converts this TransformationSummary to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.privacy.dlp.v2.TransformationSummary

TransformationSummary

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