Class protos.google.cloud.bigquery.storage.v1.BigQueryRead

Represents a BigQueryRead

Inheritance

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

Package

@google-cloud/bigquery-storage

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new BigQueryRead service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new BigQueryRead service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
BigQueryRead

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

createReadSession(request, callback)

public createReadSession(request: google.cloud.bigquery.storage.v1.ICreateReadSessionRequest, callback: google.cloud.bigquery.storage.v1.BigQueryRead.CreateReadSessionCallback): void;

Calls CreateReadSession.

Parameters
NameDescription
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
TypeDescription
void

createReadSession(request)

public createReadSession(request: google.cloud.bigquery.storage.v1.ICreateReadSessionRequest): Promise<google.cloud.bigquery.storage.v1.ReadSession>;

Calls CreateReadSession.

Parameter
NameDescription
request google.cloud.bigquery.storage.v1.ICreateReadSessionRequest

CreateReadSessionRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.bigquery.storage.v1.ReadSession>

Promise

readRows(request, callback)

public readRows(request: google.cloud.bigquery.storage.v1.IReadRowsRequest, callback: google.cloud.bigquery.storage.v1.BigQueryRead.ReadRowsCallback): void;

Calls ReadRows.

Parameters
NameDescription
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
TypeDescription
void

readRows(request)

public readRows(request: google.cloud.bigquery.storage.v1.IReadRowsRequest): Promise<google.cloud.bigquery.storage.v1.ReadRowsResponse>;

Calls ReadRows.

Parameter
NameDescription
request google.cloud.bigquery.storage.v1.IReadRowsRequest

ReadRowsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.bigquery.storage.v1.ReadRowsResponse>

Promise

splitReadStream(request, callback)

public splitReadStream(request: google.cloud.bigquery.storage.v1.ISplitReadStreamRequest, callback: google.cloud.bigquery.storage.v1.BigQueryRead.SplitReadStreamCallback): void;

Calls SplitReadStream.

Parameters
NameDescription
request 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
TypeDescription
void

splitReadStream(request)

public splitReadStream(request: google.cloud.bigquery.storage.v1.ISplitReadStreamRequest): Promise<google.cloud.bigquery.storage.v1.SplitReadStreamResponse>;

Calls SplitReadStream.

Parameter
NameDescription
request ISplitReadStreamRequest

SplitReadStreamRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.bigquery.storage.v1.SplitReadStreamResponse>

Promise