Class protos.google.bigtable.admin.v2.Snapshot (3.6.0)

Represents a Snapshot.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

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

Constructs a new Snapshot.

Parameter

Name	Description
properties	`ISnapshot` Properties to set

Properties

createTime

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

Snapshot createTime.

Property Value

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

dataSizeBytes

public dataSizeBytes: (number|Long|string);

Snapshot dataSizeBytes.

Property Value

Type	Description
(number\|Long\|string)

deleteTime

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

Snapshot deleteTime.

Property Value

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

description

public description: string;

Snapshot description.

Property Value

Type	Description
string

name

public name: string;

Snapshot name.

Property Value

Type	Description
string

sourceTable

public sourceTable?: (google.bigtable.admin.v2.ITable|null);

Snapshot sourceTable.

Property Value

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

state

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

Snapshot state.

Property Value

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

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.ISnapshot): google.bigtable.admin.v2.Snapshot;

Creates a new Snapshot instance using the specified properties.

Parameter

Name	Description
properties	`ISnapshot` Properties to set

Returns

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

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified Snapshot message. Does not implicitly messages.

Parameters

Name	Description
message	`ISnapshot` Snapshot 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.ISnapshot, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ISnapshot` Snapshot 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.Snapshot;

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

toJSON()

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

Converts this Snapshot to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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