Class protos.google.bigtable.v2.RowRange (3.5.4)

Represents a RowRange.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

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

Constructs a new RowRange.

Parameter
NameDescription
properties IRowRange

Properties to set

Properties

endKey

public endKey?: ("endKeyOpen"|"endKeyClosed");

RowRange endKey.

Property Value
TypeDescription
("endKeyOpen"|"endKeyClosed")

endKeyClosed

public endKeyClosed?: (Uint8Array|string|null);

RowRange endKeyClosed.

Property Value
TypeDescription
(Uint8Array|string|null)

endKeyOpen

public endKeyOpen?: (Uint8Array|string|null);

RowRange endKeyOpen.

Property Value
TypeDescription
(Uint8Array|string|null)

startKey

public startKey?: ("startKeyClosed"|"startKeyOpen");

RowRange startKey.

Property Value
TypeDescription
("startKeyClosed"|"startKeyOpen")

startKeyClosed

public startKeyClosed?: (Uint8Array|string|null);

RowRange startKeyClosed.

Property Value
TypeDescription
(Uint8Array|string|null)

startKeyOpen

public startKeyOpen?: (Uint8Array|string|null);

RowRange startKeyOpen.

Property Value
TypeDescription
(Uint8Array|string|null)

Methods

create(properties)

public static create(properties?: google.bigtable.v2.IRowRange): google.bigtable.v2.RowRange;

Creates a new RowRange instance using the specified properties.

Parameter
NameDescription
properties IRowRange

Properties to set

Returns
TypeDescription
google.bigtable.v2.RowRange

RowRange instance

decode(reader, length)

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

Decodes a RowRange message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.bigtable.v2.RowRange

RowRange

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.bigtable.v2.RowRange

RowRange

encode(message, writer)

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

Encodes the specified RowRange message. Does not implicitly messages.

Parameters
NameDescription
message IRowRange

RowRange message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IRowRange

RowRange message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.bigtable.v2.RowRange;

Creates a RowRange message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.bigtable.v2.RowRange

RowRange

toJSON()

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

Converts this RowRange to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.bigtable.v2.RowRange

RowRange

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a RowRange message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not