Class protos.google.bigtable.admin.v2.RestoreInfo (3.10.0)

Represents a RestoreInfo.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

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

Constructs a new RestoreInfo.

Parameter
NameDescription
properties IRestoreInfo

Properties to set

Properties

backupInfo

public backupInfo?: (google.bigtable.admin.v2.IBackupInfo|null);

RestoreInfo backupInfo.

sourceInfo

public sourceInfo?: "backupInfo";

RestoreInfo sourceInfo.

sourceType

public sourceType: (google.bigtable.admin.v2.RestoreSourceType|keyof typeof google.bigtable.admin.v2.RestoreSourceType);

RestoreInfo sourceType.

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.IRestoreInfo): google.bigtable.admin.v2.RestoreInfo;

Creates a new RestoreInfo instance using the specified properties.

Parameter
NameDescription
properties IRestoreInfo

Properties to set

Returns
TypeDescription
google.bigtable.admin.v2.RestoreInfo

RestoreInfo instance

decode(reader, length)

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

Decodes a RestoreInfo 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.RestoreInfo

RestoreInfo

decodeDelimited(reader)

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

Decodes a RestoreInfo 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.RestoreInfo

RestoreInfo

encode(message, writer)

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

Encodes the specified RestoreInfo message. Does not implicitly messages.

Parameters
NameDescription
message IRestoreInfo

RestoreInfo 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.IRestoreInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IRestoreInfo

RestoreInfo 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.RestoreInfo;

Creates a RestoreInfo 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.RestoreInfo

RestoreInfo

toJSON()

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

Converts this RestoreInfo to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

RestoreInfo

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