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

Represents a Backup.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new Backup.

Parameter

Type	Name	Description
IBackup	properties	Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Backup createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

database

public database: string;

Backup database.

Property Value

Type	Description
string

encryptionInfo

public encryptionInfo?: (google.spanner.admin.database.v1.IEncryptionInfo|null);

Backup encryptionInfo.

Property Value

Type	Description
(google.spanner.admin.database.v1.IEncryptionInfo\|null)

expireTime

public expireTime?: (google.protobuf.ITimestamp|null);

Backup expireTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

name

public name: string;

Backup name.

Property Value

Type	Description
string

referencingDatabases

public referencingDatabases: string[];

Backup referencingDatabases.

Property Value

Type	Description
string[]

sizeBytes

public sizeBytes: (number|Long|string);

Backup sizeBytes.

Property Value

Type	Description
(number\|Long\|string)

state

public state: (google.spanner.admin.database.v1.Backup.State|keyof typeof google.spanner.admin.database.v1.Backup.State);

Backup state.

Property Value

Type	Description
(google.spanner.admin.database.v1.Backup.State\|keyof typeof google.spanner.admin.database.v1.Backup.State)

versionTime

public versionTime?: (google.protobuf.ITimestamp|null);

Backup versionTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

Methods

create(properties)

public static create(properties?: google.spanner.admin.database.v1.IBackup): google.spanner.admin.database.v1.Backup;

Creates a new Backup instance using the specified properties.

Parameter

Type	Name	Description
IBackup	properties	Properties to set

Returns

Type	Description
google.spanner.admin.database.v1.Backup	Backup instance

decode(reader, length)

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

Decodes a Backup message from the specified reader or buffer.

Parameters

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from
number	length	Message length if known beforehand

Returns

Type	Description
google.spanner.admin.database.v1.Backup	Backup

decodeDelimited(reader)

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

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

Parameter

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from

Returns

Type	Description
google.spanner.admin.database.v1.Backup	Backup

encode(message, writer)

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

Encodes the specified Backup message. Does not implicitly messages.

Parameters

Type	Name	Description
IBackup	message	Backup message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

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

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

Parameters

Type	Name	Description
IBackup	message	Backup message or plain object to encode
$protobuf.Writer	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.Backup;

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

Parameter

Type	Name	Description
{ [k: string]: any }	object	Plain object

Returns

Type	Description
google.spanner.admin.database.v1.Backup	Backup

toJSON()

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

Converts this Backup to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.spanner.admin.database.v1.Backup	message	Backup
$protobuf.IConversionOptions	options	Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies a Backup message.

Parameter

Type	Name	Description
{ [k: string]: any }	message	Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not