Class protos.google.privacy.dlp.v2.RecordKey (5.3.0)

Represents a RecordKey.

Package

Constructors

(constructor)(properties)

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

Constructs a new RecordKey.

Parameter
Name	Description
`properties`	`IRecordKey` Properties to set

Properties

bigQueryKey

public bigQueryKey?: (google.privacy.dlp.v2.IBigQueryKey|null);

RecordKey bigQueryKey.

datastoreKey

public datastoreKey?: (google.privacy.dlp.v2.IDatastoreKey|null);

RecordKey datastoreKey.

idValues

public idValues: string[];

RecordKey idValues.

type

public type?: ("datastoreKey"|"bigQueryKey");

RecordKey type.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IRecordKey): google.privacy.dlp.v2.RecordKey;

Creates a new RecordKey instance using the specified properties.

Parameter
Name	Description
`properties`	`IRecordKey` Properties to set

Returns
Type	Description
`RecordKey`	RecordKey instance

decode(reader, length)

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

Decodes a RecordKey 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
`RecordKey`	RecordKey

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`RecordKey`	RecordKey

encode(message, writer)

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

Encodes the specified RecordKey message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IRecordKey` RecordKey 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.IRecordKey, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IRecordKey` RecordKey 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.RecordKey;

Creates a RecordKey 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
`RecordKey`	RecordKey

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RecordKey

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

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`RecordKey` RecordKey
`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 RecordKey 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