public static final class BigQueryReadGrpc.BigQueryReadBlockingStub extends AbstractBlockingStub<BigQueryReadGrpc.BigQueryReadBlockingStub>
A stub to allow clients to do synchronous rpc calls to service BigQueryRead.
BigQuery Read API.
The Read API can be used to read data from BigQuery.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
BigQueryReadGrpc.BigQueryReadBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
build(Channel channel, CallOptions callOptions)
protected BigQueryReadGrpc.BigQueryReadBlockingStub build(Channel channel, CallOptions callOptions)
Parameters |
Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createReadSession(CreateReadSessionRequest request)
public ReadSession createReadSession(CreateReadSessionRequest request)
Creates a new read session. A read session divides the contents of a
BigQuery table into one or more streams, which can then be used to read
data from the table. The read session also specifies properties of the
data to be read, such as a list of columns or a push-down filter describing
the rows to be returned.
A particular row can be read by at most one stream. When the caller has
reached the end of each stream in the session, then all the data in the
table has been read.
Data is assigned to each stream such that roughly the same number of
rows can be read from each stream. Because the server-side unit for
assigning data is collections of rows, the API does not guarantee that
each stream will return the same number or rows. Additionally, the
limits are enforced based on the number of pre-filtered rows, so some
filters can lead to lopsided assignments.
Read sessions automatically expire 6 hours after they are created and do
not require manual clean-up by the caller.
readRows(ReadRowsRequest request)
public Iterator<ReadRowsResponse> readRows(ReadRowsRequest request)
Reads rows from the stream in the format prescribed by the ReadSession.
Each response contains one or more table rows, up to a maximum of 100 MiB
per response; read requests which attempt to read individual rows larger
than 100 MiB will fail.
Each request also returns a set of stream statistics reflecting the current
state of the stream.
splitReadStream(SplitReadStreamRequest request)
public SplitReadStreamResponse splitReadStream(SplitReadStreamRequest request)
Splits a given ReadStream
into two ReadStream
objects. These
ReadStream
objects are referred to as the primary and the residual
streams of the split. The original ReadStream
can still be read from in
the same manner as before. Both of the returned ReadStream
objects can
also be read from, and the rows returned by both child streams will be
the same as the rows read from the original stream.
Moreover, the two child streams will be allocated back-to-back in the
original ReadStream
. Concretely, it is guaranteed that for streams
original, primary, and residual, that original[0-j] = primary[0-j] and
original[j-n] = residual[0-m] once the streams have been read to
completion.