Class protos.google.bigtable.admin.v2.RestoreTableMetadata (3.5.4)

Represents a RestoreTableMetadata.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

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

Constructs a new RestoreTableMetadata.

Parameter

Name	Description
properties	`IRestoreTableMetadata` Properties to set

Properties

backupInfo

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

RestoreTableMetadata backupInfo.

Property Value

Type	Description
(google.bigtable.admin.v2.IBackupInfo\|null)

name

public name: string;

RestoreTableMetadata name.

Property Value

Type	Description
string

optimizeTableOperationName

public optimizeTableOperationName: string;

RestoreTableMetadata optimizeTableOperationName.

Property Value

Type	Description
string

progress

public progress?: (google.bigtable.admin.v2.IOperationProgress|null);

RestoreTableMetadata progress.

Property Value

Type	Description
(google.bigtable.admin.v2.IOperationProgress\|null)

sourceInfo

public sourceInfo?: "backupInfo";

RestoreTableMetadata sourceInfo.

Property Value

Type	Description
"backupInfo"

sourceType

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

RestoreTableMetadata sourceType.

Property Value

Type	Description
(google.bigtable.admin.v2.RestoreSourceType\|keyof typeof google.bigtable.admin.v2.RestoreSourceType)

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.IRestoreTableMetadata): google.bigtable.admin.v2.RestoreTableMetadata;

Creates a new RestoreTableMetadata instance using the specified properties.

Parameter

Name	Description
properties	`IRestoreTableMetadata` Properties to set

Returns

Type	Description
google.bigtable.admin.v2.RestoreTableMetadata	RestoreTableMetadata instance

decode(reader, length)

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

Decodes a RestoreTableMetadata message from the specified reader or buffer.

Parameters

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

Returns

Type	Description
google.bigtable.admin.v2.RestoreTableMetadata	RestoreTableMetadata

decodeDelimited(reader)

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

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

Parameter

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

Returns

Type	Description
google.bigtable.admin.v2.RestoreTableMetadata	RestoreTableMetadata

encode(message, writer)

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

Encodes the specified RestoreTableMetadata message. Does not implicitly messages.

Parameters

Name	Description
message	`IRestoreTableMetadata` RestoreTableMetadata 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.bigtable.admin.v2.IRestoreTableMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IRestoreTableMetadata` RestoreTableMetadata 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.bigtable.admin.v2.RestoreTableMetadata;

Creates a RestoreTableMetadata 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
google.bigtable.admin.v2.RestoreTableMetadata	RestoreTableMetadata

toJSON()

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

Converts this RestoreTableMetadata to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.bigtable.admin.v2.RestoreTableMetadata` RestoreTableMetadata
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 RestoreTableMetadata 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