Class protos.google.bigtable.v2.ColumnRange (5.1.1)

Represents a ColumnRange.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

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

Constructs a new ColumnRange.

Parameter
Name Description
properties IColumnRange

Properties to set

Properties

endQualifier

public endQualifier?: ("endQualifierClosed"|"endQualifierOpen");

ColumnRange endQualifier.

endQualifierClosed

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

ColumnRange endQualifierClosed.

endQualifierOpen

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

ColumnRange endQualifierOpen.

familyName

public familyName: string;

ColumnRange familyName.

startQualifier

public startQualifier?: ("startQualifierClosed"|"startQualifierOpen");

ColumnRange startQualifier.

startQualifierClosed

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

ColumnRange startQualifierClosed.

startQualifierOpen

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

ColumnRange startQualifierOpen.

Methods

create(properties)

public static create(properties?: google.bigtable.v2.IColumnRange): google.bigtable.v2.ColumnRange;

Creates a new ColumnRange instance using the specified properties.

Parameter
Name Description
properties IColumnRange

Properties to set

Returns
Type Description
ColumnRange

ColumnRange instance

decode(reader, length)

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

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

ColumnRange

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ColumnRange

ColumnRange

encode(message, writer)

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

Encodes the specified ColumnRange message. Does not implicitly messages.

Parameters
Name Description
message IColumnRange

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

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

Parameters
Name Description
message IColumnRange

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

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

ColumnRange

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ColumnRange

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ColumnRange

ColumnRange

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