Class protos.google.privacy.dlp.v2.FieldTransformation

Represents a FieldTransformation.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new FieldTransformation.

Parameter
NameDescription
properties IFieldTransformation

Properties to set

Properties

condition

public condition?: (google.privacy.dlp.v2.IRecordCondition|null);

FieldTransformation condition.

fields

public fields: google.privacy.dlp.v2.IFieldId[];

FieldTransformation fields.

infoTypeTransformations

public infoTypeTransformations?: (google.privacy.dlp.v2.IInfoTypeTransformations|null);

FieldTransformation infoTypeTransformations.

primitiveTransformation

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

FieldTransformation primitiveTransformation.

transformation

public transformation?: ("primitiveTransformation"|"infoTypeTransformations");

FieldTransformation transformation.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IFieldTransformation): google.privacy.dlp.v2.FieldTransformation;

Creates a new FieldTransformation instance using the specified properties.

Parameter
NameDescription
properties IFieldTransformation

Properties to set

Returns
TypeDescription
google.privacy.dlp.v2.FieldTransformation

FieldTransformation instance

decode(reader, length)

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

Decodes a FieldTransformation 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.FieldTransformation

FieldTransformation

decodeDelimited(reader)

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

Decodes a FieldTransformation 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.FieldTransformation

FieldTransformation

encode(message, writer)

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

Encodes the specified FieldTransformation message. Does not implicitly messages.

Parameters
NameDescription
message IFieldTransformation

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

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

Parameters
NameDescription
message IFieldTransformation

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

Creates a FieldTransformation 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.FieldTransformation

FieldTransformation

toJSON()

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

Converts this FieldTransformation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

FieldTransformation

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