Class protos.google.bigtable.v2.ReadChangeStreamResponse.Heartbeat (5.1.1)

Represents a Heartbeat.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

constructor(properties?: google.bigtable.v2.ReadChangeStreamResponse.IHeartbeat);

Constructs a new Heartbeat.

Parameter
Name Description
properties IHeartbeat

Properties to set

Properties

continuationToken

public continuationToken?: (google.bigtable.v2.IStreamContinuationToken|null);

Heartbeat continuationToken.

estimatedLowWatermark

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

Heartbeat estimatedLowWatermark.

Methods

create(properties)

public static create(properties?: google.bigtable.v2.ReadChangeStreamResponse.IHeartbeat): google.bigtable.v2.ReadChangeStreamResponse.Heartbeat;

Creates a new Heartbeat instance using the specified properties.

Parameter
Name Description
properties IHeartbeat

Properties to set

Returns
Type Description
Heartbeat

Heartbeat instance

decode(reader, length)

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

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

Heartbeat

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Heartbeat

Heartbeat

encode(message, writer)

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

Encodes the specified Heartbeat message. Does not implicitly messages.

Parameters
Name Description
message IHeartbeat

Heartbeat 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.v2.ReadChangeStreamResponse.IHeartbeat, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IHeartbeat

Heartbeat 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.v2.ReadChangeStreamResponse.Heartbeat;

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

Heartbeat

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Heartbeat

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Heartbeat

Heartbeat

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