Class protos.google.cloud.bigquery.storage.v1.BigQueryWrite (4.5.0)

Represents a BigQueryWrite

Inheritance

$protobuf.rpc.Service > protos.google.cloud.bigquery.storage.v1.BigQueryWrite

Package

@google-cloud/bigquery-storage

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new BigQueryWrite service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

appendRows(request, callback)

public appendRows(request: google.cloud.bigquery.storage.v1.IAppendRowsRequest, callback: google.cloud.bigquery.storage.v1.BigQueryWrite.AppendRowsCallback): void;

Calls AppendRows.

Parameters
Name Description
request IAppendRowsRequest

AppendRowsRequest message or plain object
callback AppendRowsCallback

Node-style callback called with the error, if any, and AppendRowsResponse
Returns
Type Description
void

appendRows(request)

public appendRows(request: google.cloud.bigquery.storage.v1.IAppendRowsRequest): Promise<google.cloud.bigquery.storage.v1.AppendRowsResponse>;

Calls AppendRows.

Parameter
Name Description
request IAppendRowsRequest

AppendRowsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.storage.v1.AppendRowsResponse>

Promise

batchCommitWriteStreams(request, callback)

public batchCommitWriteStreams(request: google.cloud.bigquery.storage.v1.IBatchCommitWriteStreamsRequest, callback: google.cloud.bigquery.storage.v1.BigQueryWrite.BatchCommitWriteStreamsCallback): void;

Calls BatchCommitWriteStreams.

Parameters
Name Description
request IBatchCommitWriteStreamsRequest

BatchCommitWriteStreamsRequest message or plain object
callback BatchCommitWriteStreamsCallback

Node-style callback called with the error, if any, and BatchCommitWriteStreamsResponse
Returns
Type Description
void

batchCommitWriteStreams(request)

public batchCommitWriteStreams(request: google.cloud.bigquery.storage.v1.IBatchCommitWriteStreamsRequest): Promise<google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse>;

Calls BatchCommitWriteStreams.

Parameter
Name Description
request IBatchCommitWriteStreamsRequest

BatchCommitWriteStreamsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): BigQueryWrite;

Creates new BigQueryWrite service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
BigQueryWrite

RPC service. Useful where requests and/or responses are streamed.

createWriteStream(request, callback)

public createWriteStream(request: google.cloud.bigquery.storage.v1.ICreateWriteStreamRequest, callback: google.cloud.bigquery.storage.v1.BigQueryWrite.CreateWriteStreamCallback): void;

Calls CreateWriteStream.

Parameters
Name Description
request ICreateWriteStreamRequest

CreateWriteStreamRequest message or plain object
callback CreateWriteStreamCallback

Node-style callback called with the error, if any, and WriteStream
Returns
Type Description
void

createWriteStream(request)

public createWriteStream(request: google.cloud.bigquery.storage.v1.ICreateWriteStreamRequest): Promise<google.cloud.bigquery.storage.v1.WriteStream>;

Calls CreateWriteStream.

Parameter
Name Description
request ICreateWriteStreamRequest

CreateWriteStreamRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.storage.v1.WriteStream>

Promise

finalizeWriteStream(request, callback)

public finalizeWriteStream(request: google.cloud.bigquery.storage.v1.IFinalizeWriteStreamRequest, callback: google.cloud.bigquery.storage.v1.BigQueryWrite.FinalizeWriteStreamCallback): void;

Calls FinalizeWriteStream.

Parameters
Name Description
request IFinalizeWriteStreamRequest

FinalizeWriteStreamRequest message or plain object
callback FinalizeWriteStreamCallback

Node-style callback called with the error, if any, and FinalizeWriteStreamResponse
Returns
Type Description
void

finalizeWriteStream(request)

public finalizeWriteStream(request: google.cloud.bigquery.storage.v1.IFinalizeWriteStreamRequest): Promise<google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse>;

Calls FinalizeWriteStream.

Parameter
Name Description
request IFinalizeWriteStreamRequest

FinalizeWriteStreamRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse>

Promise

flushRows(request, callback)

public flushRows(request: google.cloud.bigquery.storage.v1.IFlushRowsRequest, callback: google.cloud.bigquery.storage.v1.BigQueryWrite.FlushRowsCallback): void;

Calls FlushRows.

Parameters
Name Description
request IFlushRowsRequest

FlushRowsRequest message or plain object
callback FlushRowsCallback

Node-style callback called with the error, if any, and FlushRowsResponse
Returns
Type Description
void

flushRows(request)

public flushRows(request: google.cloud.bigquery.storage.v1.IFlushRowsRequest): Promise<google.cloud.bigquery.storage.v1.FlushRowsResponse>;

Calls FlushRows.

Parameter
Name Description
request IFlushRowsRequest

FlushRowsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.storage.v1.FlushRowsResponse>

Promise

getWriteStream(request, callback)

public getWriteStream(request: google.cloud.bigquery.storage.v1.IGetWriteStreamRequest, callback: google.cloud.bigquery.storage.v1.BigQueryWrite.GetWriteStreamCallback): void;

Calls GetWriteStream.

Parameters
Name Description
request IGetWriteStreamRequest

GetWriteStreamRequest message or plain object
callback GetWriteStreamCallback

Node-style callback called with the error, if any, and WriteStream
Returns
Type Description
void

getWriteStream(request)

public getWriteStream(request: google.cloud.bigquery.storage.v1.IGetWriteStreamRequest): Promise<google.cloud.bigquery.storage.v1.WriteStream>;

Calls GetWriteStream.

Parameter
Name Description
request IGetWriteStreamRequest

GetWriteStreamRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.storage.v1.WriteStream>

Promise