Represents a KeyRange.
Package
@google-cloud/spanner!Constructors
(constructor)(properties)
constructor(properties?: google.spanner.v1.IKeyRange);
Constructs a new KeyRange.
Type | Name | Description |
---|---|---|
IKeyRange | properties |
Properties to set |
Properties
endClosed
public endClosed?: (google.protobuf.IListValue|null);
KeyRange endClosed.
Type | Description |
---|---|
(google.protobuf.IListValue|null) |
endKeyType
public endKeyType?: ("endClosed"|"endOpen");
KeyRange endKeyType.
Type | Description |
---|---|
("endClosed"|"endOpen") |
endOpen
public endOpen?: (google.protobuf.IListValue|null);
KeyRange endOpen.
Type | Description |
---|---|
(google.protobuf.IListValue|null) |
startClosed
public startClosed?: (google.protobuf.IListValue|null);
KeyRange startClosed.
Type | Description |
---|---|
(google.protobuf.IListValue|null) |
startKeyType
public startKeyType?: ("startClosed"|"startOpen");
KeyRange startKeyType.
Type | Description |
---|---|
("startClosed"|"startOpen") |
startOpen
public startOpen?: (google.protobuf.IListValue|null);
KeyRange startOpen.
Type | Description |
---|---|
(google.protobuf.IListValue|null) |
Methods
create(properties)
public static create(properties?: google.spanner.v1.IKeyRange): google.spanner.v1.KeyRange;
Creates a new KeyRange instance using the specified properties.
Type | Name | Description |
---|---|---|
IKeyRange | properties |
Properties to set |
Type | Description |
---|---|
google.spanner.v1.KeyRange | KeyRange instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.v1.KeyRange;
Decodes a KeyRange message from the specified reader or buffer.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
number | length |
Message length if known beforehand |
Type | Description |
---|---|
google.spanner.v1.KeyRange | KeyRange |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.v1.KeyRange;
Decodes a KeyRange message from the specified reader or buffer, length delimited.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
Type | Description |
---|---|
google.spanner.v1.KeyRange | KeyRange |
encode(message, writer)
public static encode(message: google.spanner.v1.IKeyRange, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified KeyRange message. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IKeyRange | message |
KeyRange message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.spanner.v1.IKeyRange, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified KeyRange message, length delimited. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IKeyRange | message |
KeyRange message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.spanner.v1.KeyRange;
Creates a KeyRange message from a plain object. Also converts values to their respective internal types.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | object |
Plain object |
Type | Description |
---|---|
google.spanner.v1.KeyRange | KeyRange |
toJSON()
public toJSON(): { [k: string]: any };
Converts this KeyRange to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.spanner.v1.KeyRange, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a KeyRange message. Also converts values to other types if specified.
Type | Name | Description |
---|---|---|
google.spanner.v1.KeyRange | message |
KeyRange |
$protobuf.IConversionOptions | options |
Conversion options |
Type | Description |
---|---|
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a KeyRange message.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | message |
Plain object to verify |
Type | Description |
---|---|
(string|null) |
|