Constructor
new ReadRequest(propertiesopt)
Constructs a new ReadRequest.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.v1.IReadRequest |
<optional> |
Properties to set |
- Implements:
-
- IReadRequest
Members
columns
ReadRequest columns.
dataBoostEnabled
ReadRequest dataBoostEnabled.
directedReadOptions
ReadRequest directedReadOptions.
index
ReadRequest index.
keySet
ReadRequest keySet.
limit
ReadRequest limit.
lockHint
ReadRequest lockHint.
orderBy
ReadRequest orderBy.
partitionToken
ReadRequest partitionToken.
requestOptions
ReadRequest requestOptions.
resumeToken
ReadRequest resumeToken.
session
ReadRequest session.
table
ReadRequest table.
transaction
ReadRequest transaction.
LockHint
LockHint enum.
Properties:
| Name | Type | Description |
|---|---|---|
LOCK_HINT_UNSPECIFIED |
number |
LOCK_HINT_UNSPECIFIED value |
LOCK_HINT_SHARED |
number |
LOCK_HINT_SHARED value |
LOCK_HINT_EXCLUSIVE |
number |
LOCK_HINT_EXCLUSIVE value |
OrderBy
OrderBy enum.
Properties:
| Name | Type | Description |
|---|---|---|
ORDER_BY_UNSPECIFIED |
number |
ORDER_BY_UNSPECIFIED value |
ORDER_BY_PRIMARY_KEY |
number |
ORDER_BY_PRIMARY_KEY value |
ORDER_BY_NO_ORDER |
number |
ORDER_BY_NO_ORDER value |
Methods
toJSON() → {Object.<string, *>}
Converts this ReadRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.spanner.v1.ReadRequest}
Creates a new ReadRequest instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.v1.IReadRequest |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.spanner.v1.ReadRequest |
ReadRequest instance |
(static) decode(reader, lengthopt) → {google.spanner.v1.ReadRequest}
Decodes a ReadRequest message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.spanner.v1.ReadRequest |
ReadRequest |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.spanner.v1.ReadRequest}
Decodes a ReadRequest message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.spanner.v1.ReadRequest |
ReadRequest |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified ReadRequest message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.v1.IReadRequest |
ReadRequest message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified ReadRequest message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.v1.IReadRequest |
ReadRequest message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.spanner.v1.ReadRequest}
Creates a ReadRequest message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.spanner.v1.ReadRequest |
ReadRequest |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for ReadRequest
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a ReadRequest message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.v1.ReadRequest |
ReadRequest |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a ReadRequest message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|