Class protos.google.bigtable.v2.ReadChangeStreamResponse (5.0.0)

Represents a ReadChangeStreamResponse.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.bigtable.v2.IReadChangeStreamResponse);

Constructs a new ReadChangeStreamResponse.

Parameter
Name	Description
`properties`	`IReadChangeStreamResponse` Properties to set

Properties

closeStream

public closeStream?: (google.bigtable.v2.ReadChangeStreamResponse.ICloseStream|null);

ReadChangeStreamResponse closeStream.

dataChange

public dataChange?: (google.bigtable.v2.ReadChangeStreamResponse.IDataChange|null);

ReadChangeStreamResponse dataChange.

heartbeat

public heartbeat?: (google.bigtable.v2.ReadChangeStreamResponse.IHeartbeat|null);

ReadChangeStreamResponse heartbeat.

streamRecord

public streamRecord?: ("dataChange"|"heartbeat"|"closeStream");

ReadChangeStreamResponse streamRecord.

Methods

create(properties)

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

Creates a new ReadChangeStreamResponse instance using the specified properties.

Parameter
Name	Description
`properties`	`IReadChangeStreamResponse` Properties to set

Returns
Type	Description
`ReadChangeStreamResponse`	ReadChangeStreamResponse instance

decode(reader, length)

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

Decodes a ReadChangeStreamResponse 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
`ReadChangeStreamResponse`	ReadChangeStreamResponse

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`ReadChangeStreamResponse`	ReadChangeStreamResponse

encode(message, writer)

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

Encodes the specified ReadChangeStreamResponse message. Does not implicitly messages.

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

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

Parameters
Name	Description
`message`	`IReadChangeStreamResponse` ReadChangeStreamResponse 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;

Creates a ReadChangeStreamResponse 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
`ReadChangeStreamResponse`	ReadChangeStreamResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ReadChangeStreamResponse

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`ReadChangeStreamResponse` ReadChangeStreamResponse
`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 ReadChangeStreamResponse 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