Class protos.google.privacy.dlp.v2.TransformationDescription (5.10.0)

Represents a TransformationDescription.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new TransformationDescription.

Parameter
Name Description
properties ITransformationDescription

Properties to set

Properties

condition

public condition: string;

TransformationDescription condition.

description

public description: string;

TransformationDescription description.

infoType

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

TransformationDescription infoType.

type

public type: (google.privacy.dlp.v2.TransformationType|keyof typeof google.privacy.dlp.v2.TransformationType);

TransformationDescription type.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.ITransformationDescription): google.privacy.dlp.v2.TransformationDescription;

Creates a new TransformationDescription instance using the specified properties.

Parameter
Name Description
properties ITransformationDescription

Properties to set

Returns
Type Description
TransformationDescription

TransformationDescription instance

decode(reader, length)

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

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

TransformationDescription

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TransformationDescription

TransformationDescription

encode(message, writer)

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

Encodes the specified TransformationDescription message. Does not implicitly messages.

Parameters
Name Description
message ITransformationDescription

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

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

Parameters
Name Description
message ITransformationDescription

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

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

TransformationDescription

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TransformationDescription

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message TransformationDescription

TransformationDescription

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