Class protos.google.privacy.dlp.v2.Key (3.3.0)

Represents a Key.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new Key.

Parameter
Name Description
properties IKey

Properties to set

Properties

partitionId

public partitionId?: (google.privacy.dlp.v2.IPartitionId|null);

Key partitionId.

path

public path: google.privacy.dlp.v2.Key.IPathElement[];

Key path.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IKey): google.privacy.dlp.v2.Key;

Creates a new Key instance using the specified properties.

Parameter
Name Description
properties IKey

Properties to set
Returns
Type Description
google.privacy.dlp.v2.Key

Key instance

decode(reader, length)

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

Decodes a Key message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.privacy.dlp.v2.Key

Key

decodeDelimited(reader)

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

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.privacy.dlp.v2.Key

Key

encode(message, writer)

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

Encodes the specified Key message. Does not implicitly messages.

Parameters
Name Description
message IKey

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

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

Parameters
Name Description
message IKey

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

Creates a Key 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
google.privacy.dlp.v2.Key

Key

toJSON()

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

Converts this Key to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.privacy.dlp.v2.Key

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