Class protos.google.spanner.admin.database.v1.EncryptionInfo

Represents an EncryptionInfo.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

constructor(properties?: google.spanner.admin.database.v1.IEncryptionInfo);

Constructs a new EncryptionInfo.

Parameter
TypeNameDescription
IEncryptionInfoproperties

Properties to set

Properties

encryptionStatus

public encryptionStatus?: (google.rpc.IStatus|null);

EncryptionInfo encryptionStatus.

Property Value
TypeDescription
(google.rpc.IStatus|null)

encryptionType

public encryptionType: (google.spanner.admin.database.v1.EncryptionInfo.Type|keyof typeof google.spanner.admin.database.v1.EncryptionInfo.Type);

EncryptionInfo encryptionType.

Property Value
TypeDescription
(google.spanner.admin.database.v1.EncryptionInfo.Type|keyof typeof google.spanner.admin.database.v1.EncryptionInfo.Type)

kmsKeyVersion

public kmsKeyVersion: string;

EncryptionInfo kmsKeyVersion.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.spanner.admin.database.v1.IEncryptionInfo): google.spanner.admin.database.v1.EncryptionInfo;

Creates a new EncryptionInfo instance using the specified properties.

Parameter
TypeNameDescription
IEncryptionInfoproperties

Properties to set

Returns
TypeDescription
google.spanner.admin.database.v1.EncryptionInfo

EncryptionInfo instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.admin.database.v1.EncryptionInfo;

Decodes an EncryptionInfo message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.spanner.admin.database.v1.EncryptionInfo

EncryptionInfo

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.admin.database.v1.EncryptionInfo;

Decodes an EncryptionInfo message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.spanner.admin.database.v1.EncryptionInfo

EncryptionInfo

encode(message, writer)

public static encode(message: google.spanner.admin.database.v1.IEncryptionInfo, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified EncryptionInfo message. Does not implicitly messages.

Parameters
TypeNameDescription
IEncryptionInfomessage

EncryptionInfo message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.spanner.admin.database.v1.IEncryptionInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
IEncryptionInfomessage

EncryptionInfo message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.spanner.admin.database.v1.EncryptionInfo;

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

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

Plain object

Returns
TypeDescription
google.spanner.admin.database.v1.EncryptionInfo

EncryptionInfo

toJSON()

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

Converts this EncryptionInfo to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.spanner.admin.database.v1.EncryptionInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
TypeNameDescription
google.spanner.admin.database.v1.EncryptionInfomessage

EncryptionInfo

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an EncryptionInfo message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not