Class protos.google.cloud.bigquery.storage.v1.BigQueryRead (2.8.0)

Version 2.8.0

• 4.10.0 (latest)
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.1
• 4.1.0
• 4.0.0
• 3.4.0
• 3.2.0
• 3.1.1
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.4
• 2.3.0

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

Name	Description
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

Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns

Type	Description
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

Name	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
void

createReadSession(request)

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

Calls CreateReadSession.

Parameter

Name	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)

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

Calls ReadRows.

Parameters

Name	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
void

readRows(request)

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

Calls ReadRows.

Parameter

Name	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)

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

Calls SplitReadStream.

Parameters

Name	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
void

splitReadStream(request)

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

Calls SplitReadStream.

Parameter

Name	Description
request	google.cloud.bigquery.storage.v1.ISplitReadStreamRequest SplitReadStreamRequest message or plain object

Returns

Type	Description
Promise<google.cloud.bigquery.storage.v1.SplitReadStreamResponse>	Promise