Constructor
new BigQueryRead(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new BigQueryRead service.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
createReadSession(request, callback) → {undefined}
Calls CreateReadSession.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.ICreateReadSessionRequest |
CreateReadSessionRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryRead.CreateReadSessionCallback |
Node-style callback called with the error, if any, and ReadSession |
Returns:
| Type | Description |
|---|---|
| undefined |
createReadSession(request) → {Promise.<google.cloud.bigquery.storage.v1.ReadSession>}
Calls CreateReadSession.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.ICreateReadSessionRequest |
CreateReadSessionRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.ReadSession> |
Promise |
readRows(request, callback) → {undefined}
Calls ReadRows.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IReadRowsRequest |
ReadRowsRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryRead.ReadRowsCallback |
Node-style callback called with the error, if any, and ReadRowsResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
readRows(request) → {Promise.<google.cloud.bigquery.storage.v1.ReadRowsResponse>}
Calls ReadRows.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IReadRowsRequest |
ReadRowsRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.ReadRowsResponse> |
Promise |
splitReadStream(request, callback) → {undefined}
Calls SplitReadStream.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.ISplitReadStreamRequest |
SplitReadStreamRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryRead.SplitReadStreamCallback |
Node-style callback called with the error, if any, and SplitReadStreamResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
splitReadStream(request) → {Promise.<google.cloud.bigquery.storage.v1.SplitReadStreamResponse>}
Calls SplitReadStream.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.ISplitReadStreamRequest |
SplitReadStreamRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.SplitReadStreamResponse> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {BigQueryRead}
Creates new BigQueryRead service using the specified rpc implementation.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
| Type | Description |
|---|---|
| BigQueryRead |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
CreateReadSessionCallback(error, responseopt)
Callback as used by createReadSession.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.ReadSession |
<optional> |
ReadSession |
ReadRowsCallback(error, responseopt)
Callback as used by readRows.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.ReadRowsResponse |
<optional> |
ReadRowsResponse |
SplitReadStreamCallback(error, responseopt)
Callback as used by splitReadStream.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.SplitReadStreamResponse |
<optional> |
SplitReadStreamResponse |