Constructor
new BigQueryWrite(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new BigQueryWrite 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
appendRows(request, callback) → {undefined}
Calls AppendRows.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IAppendRowsRequest |
AppendRowsRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryWrite.AppendRowsCallback |
Node-style callback called with the error, if any, and AppendRowsResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
appendRows(request) → {Promise.<google.cloud.bigquery.storage.v1.AppendRowsResponse>}
Calls AppendRows.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IAppendRowsRequest |
AppendRowsRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.AppendRowsResponse> |
Promise |
batchCommitWriteStreams(request, callback) → {undefined}
Calls BatchCommitWriteStreams.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IBatchCommitWriteStreamsRequest |
BatchCommitWriteStreamsRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryWrite.BatchCommitWriteStreamsCallback |
Node-style callback called with the error, if any, and BatchCommitWriteStreamsResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
batchCommitWriteStreams(request) → {Promise.<google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse>}
Calls BatchCommitWriteStreams.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IBatchCommitWriteStreamsRequest |
BatchCommitWriteStreamsRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse> |
Promise |
createWriteStream(request, callback) → {undefined}
Calls CreateWriteStream.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.ICreateWriteStreamRequest |
CreateWriteStreamRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryWrite.CreateWriteStreamCallback |
Node-style callback called with the error, if any, and WriteStream |
Returns:
| Type | Description |
|---|---|
| undefined |
createWriteStream(request) → {Promise.<google.cloud.bigquery.storage.v1.WriteStream>}
Calls CreateWriteStream.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.ICreateWriteStreamRequest |
CreateWriteStreamRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.WriteStream> |
Promise |
finalizeWriteStream(request, callback) → {undefined}
Calls FinalizeWriteStream.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IFinalizeWriteStreamRequest |
FinalizeWriteStreamRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryWrite.FinalizeWriteStreamCallback |
Node-style callback called with the error, if any, and FinalizeWriteStreamResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
finalizeWriteStream(request) → {Promise.<google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse>}
Calls FinalizeWriteStream.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IFinalizeWriteStreamRequest |
FinalizeWriteStreamRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse> |
Promise |
flushRows(request, callback) → {undefined}
Calls FlushRows.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IFlushRowsRequest |
FlushRowsRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryWrite.FlushRowsCallback |
Node-style callback called with the error, if any, and FlushRowsResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
flushRows(request) → {Promise.<google.cloud.bigquery.storage.v1.FlushRowsResponse>}
Calls FlushRows.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IFlushRowsRequest |
FlushRowsRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.FlushRowsResponse> |
Promise |
getWriteStream(request, callback) → {undefined}
Calls GetWriteStream.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IGetWriteStreamRequest |
GetWriteStreamRequest message or plain object |
callback |
google.cloud.bigquery.storage.v1.BigQueryWrite.GetWriteStreamCallback |
Node-style callback called with the error, if any, and WriteStream |
Returns:
| Type | Description |
|---|---|
| undefined |
getWriteStream(request) → {Promise.<google.cloud.bigquery.storage.v1.WriteStream>}
Calls GetWriteStream.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.bigquery.storage.v1.IGetWriteStreamRequest |
GetWriteStreamRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.bigquery.storage.v1.WriteStream> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {BigQueryWrite}
Creates new BigQueryWrite 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 |
|---|---|
| BigQueryWrite |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
AppendRowsCallback(error, responseopt)
Callback as used by appendRows.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.AppendRowsResponse |
<optional> |
AppendRowsResponse |
BatchCommitWriteStreamsCallback(error, responseopt)
Callback as used by batchCommitWriteStreams.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse |
<optional> |
BatchCommitWriteStreamsResponse |
CreateWriteStreamCallback(error, responseopt)
Callback as used by createWriteStream.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.WriteStream |
<optional> |
WriteStream |
FinalizeWriteStreamCallback(error, responseopt)
Callback as used by finalizeWriteStream.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse |
<optional> |
FinalizeWriteStreamResponse |
FlushRowsCallback(error, responseopt)
Callback as used by flushRows.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.FlushRowsResponse |
<optional> |
FlushRowsResponse |
GetWriteStreamCallback(error, responseopt)
Callback as used by getWriteStream.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.bigquery.storage.v1.WriteStream |
<optional> |
WriteStream |