Class protos.google.bigtable.admin.v2.SnapshotTableMetadata (5.0.0)

Represents a SnapshotTableMetadata.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

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

Constructs a new SnapshotTableMetadata.

Parameter
Name Description
properties ISnapshotTableMetadata

Properties to set

Properties

finishTime

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

SnapshotTableMetadata finishTime.

originalRequest

public originalRequest?: (google.bigtable.admin.v2.ISnapshotTableRequest|null);

SnapshotTableMetadata originalRequest.

requestTime

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

SnapshotTableMetadata requestTime.

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.ISnapshotTableMetadata): google.bigtable.admin.v2.SnapshotTableMetadata;

Creates a new SnapshotTableMetadata instance using the specified properties.

Parameter
Name Description
properties ISnapshotTableMetadata

Properties to set

Returns
Type Description
SnapshotTableMetadata

SnapshotTableMetadata instance

decode(reader, length)

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

Decodes a SnapshotTableMetadata message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
SnapshotTableMetadata

SnapshotTableMetadata

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SnapshotTableMetadata

SnapshotTableMetadata

encode(message, writer)

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

Encodes the specified SnapshotTableMetadata message. Does not implicitly messages.

Parameters
Name Description
message ISnapshotTableMetadata

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

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

Parameters
Name Description
message ISnapshotTableMetadata

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

Creates a SnapshotTableMetadata 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
SnapshotTableMetadata

SnapshotTableMetadata

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SnapshotTableMetadata

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

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

Converts this SnapshotTableMetadata to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SnapshotTableMetadata

SnapshotTableMetadata

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