Class protos.google.bigtable.admin.v2.HotTablet (5.1.1)

Represents a HotTablet.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

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

Constructs a new HotTablet.

Parameter
Name Description
properties IHotTablet

Properties to set

Properties

endKey

public endKey: string;

HotTablet endKey.

endTime

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

HotTablet endTime.

name

public name: string;

HotTablet name.

nodeCpuUsagePercent

public nodeCpuUsagePercent: number;

HotTablet nodeCpuUsagePercent.

startKey

public startKey: string;

HotTablet startKey.

startTime

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

HotTablet startTime.

tableName

public tableName: string;

HotTablet tableName.

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.IHotTablet): google.bigtable.admin.v2.HotTablet;

Creates a new HotTablet instance using the specified properties.

Parameter
Name Description
properties IHotTablet

Properties to set

Returns
Type Description
HotTablet

HotTablet instance

decode(reader, length)

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

Decodes a HotTablet 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
HotTablet

HotTablet

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HotTablet

HotTablet

encode(message, writer)

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

Encodes the specified HotTablet message. Does not implicitly messages.

Parameters
Name Description
message IHotTablet

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

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

Parameters
Name Description
message IHotTablet

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

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

HotTablet

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HotTablet

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 HotTablet to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HotTablet

HotTablet

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