Class protos.google.spanner.admin.database.v1.CreateBackupEncryptionConfig (7.5.0)

Represents a CreateBackupEncryptionConfig.

Package

@google-cloud/spanner

Constructors

(constructor)(properties)

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

Constructs a new CreateBackupEncryptionConfig.

Parameter
Name Description
properties ICreateBackupEncryptionConfig

Properties to set

Properties

encryptionType

public encryptionType: (google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType|keyof typeof google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType);

CreateBackupEncryptionConfig encryptionType.

kmsKeyName

public kmsKeyName: string;

CreateBackupEncryptionConfig kmsKeyName.

Methods

create(properties)

public static create(properties?: google.spanner.admin.database.v1.ICreateBackupEncryptionConfig): google.spanner.admin.database.v1.CreateBackupEncryptionConfig;

Creates a new CreateBackupEncryptionConfig instance using the specified properties.

Parameter
Name Description
properties ICreateBackupEncryptionConfig

Properties to set
Returns
Type Description
CreateBackupEncryptionConfig

CreateBackupEncryptionConfig instance

decode(reader, length)

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

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

CreateBackupEncryptionConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
CreateBackupEncryptionConfig

CreateBackupEncryptionConfig

encode(message, writer)

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

Encodes the specified CreateBackupEncryptionConfig message. Does not implicitly messages.

Parameters
Name Description
message ICreateBackupEncryptionConfig

CreateBackupEncryptionConfig 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.spanner.admin.database.v1.ICreateBackupEncryptionConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICreateBackupEncryptionConfig

CreateBackupEncryptionConfig 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.spanner.admin.database.v1.CreateBackupEncryptionConfig;

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

CreateBackupEncryptionConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CreateBackupEncryptionConfig

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CreateBackupEncryptionConfig

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