Class protos.google.bigtable.v2.ValueRange (4.1.0)

Represents a ValueRange.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

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

Constructs a new ValueRange.

Parameter
NameDescription
properties IValueRange

Properties to set

Properties

endValue

public endValue?: ("endValueClosed"|"endValueOpen");

ValueRange endValue.

endValueClosed

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

ValueRange endValueClosed.

endValueOpen

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

ValueRange endValueOpen.

startValue

public startValue?: ("startValueClosed"|"startValueOpen");

ValueRange startValue.

startValueClosed

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

ValueRange startValueClosed.

startValueOpen

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

ValueRange startValueOpen.

Methods

create(properties)

public static create(properties?: google.bigtable.v2.IValueRange): google.bigtable.v2.ValueRange;

Creates a new ValueRange instance using the specified properties.

Parameter
NameDescription
properties IValueRange

Properties to set

Returns
TypeDescription
google.bigtable.v2.ValueRange

ValueRange instance

decode(reader, length)

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

Decodes a ValueRange 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.ValueRange

ValueRange

decodeDelimited(reader)

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

Decodes a ValueRange 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.ValueRange

ValueRange

encode(message, writer)

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

Encodes the specified ValueRange message. Does not implicitly messages.

Parameters
NameDescription
message IValueRange

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

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

Parameters
NameDescription
message IValueRange

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

Creates a ValueRange 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.ValueRange

ValueRange

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ValueRange

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this ValueRange to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.bigtable.v2.ValueRange

ValueRange

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