Class protos.google.bigtable.admin.v2.Backup

Represents a Backup.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

constructor(properties?: google.bigtable.admin.v2.IBackup);

Constructs a new Backup.

Parameter
NameDescription
properties IBackup

Properties to set

Properties

encryptionInfo

public encryptionInfo?: (google.bigtable.admin.v2.IEncryptionInfo|null);

Backup encryptionInfo.

endTime

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

Backup endTime.

expireTime

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

Backup expireTime.

name

public name: string;

Backup name.

sizeBytes

public sizeBytes: (number|Long|string);

Backup sizeBytes.

sourceTable

public sourceTable: string;

Backup sourceTable.

startTime

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

Backup startTime.

state

public state: (google.bigtable.admin.v2.Backup.State|keyof typeof google.bigtable.admin.v2.Backup.State);

Backup state.

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.IBackup): google.bigtable.admin.v2.Backup;

Creates a new Backup instance using the specified properties.

Parameter
NameDescription
properties IBackup

Properties to set

Returns
TypeDescription
google.bigtable.admin.v2.Backup

Backup instance

decode(reader, length)

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

Decodes a Backup message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.bigtable.admin.v2.Backup

Backup

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.bigtable.admin.v2.Backup;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.bigtable.admin.v2.Backup

Backup

encode(message, writer)

public static encode(message: google.bigtable.admin.v2.IBackup, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Backup message. Does not implicitly messages.

Parameters
NameDescription
message IBackup

Backup message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.bigtable.admin.v2.IBackup, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBackup

Backup message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.bigtable.admin.v2.Backup;

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

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

Plain object

Returns
TypeDescription
google.bigtable.admin.v2.Backup

Backup

toJSON()

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

Converts this Backup to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.bigtable.admin.v2.Backup

Backup

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Backup message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not