com.google.cloud.bigquery.storage.v1beta1

Class BigQueryStorageGrpc.BigQueryStorageFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<BigQueryStorageGrpc.BigQueryStorageFutureStub>

com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageGrpc.BigQueryStorageFutureStub

Enclosing class:

BigQueryStorageGrpc

public static final class BigQueryStorageGrpc.BigQueryStorageFutureStub
extends io.grpc.stub.AbstractFutureStub<BigQueryStorageGrpc.BigQueryStorageFutureStub>

 BigQuery storage API.
 The BigQuery storage API can be used to read data stored in BigQuery.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Storage.BatchCreateReadSessionStreamsResponse>	batchCreateReadSessionStreams(Storage.BatchCreateReadSessionStreamsRequest request) Creates additional streams for a ReadSession.
protected BigQueryStorageGrpc.BigQueryStorageFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Storage.ReadSession>	createReadSession(Storage.CreateReadSessionRequest request) Creates a new read session.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	finalizeStream(Storage.FinalizeStreamRequest request) Triggers the graceful termination of a single stream in a ReadSession.
com.google.common.util.concurrent.ListenableFuture<Storage.SplitReadStreamResponse>	splitReadStream(Storage.SplitReadStreamRequest request) Splits a given read stream into two Streams.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected BigQueryStorageGrpc.BigQueryStorageFutureStub build(io.grpc.Channel channel,
                                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<BigQueryStorageGrpc.BigQueryStorageFutureStub>

createReadSession

public com.google.common.util.concurrent.ListenableFuture<Storage.ReadSession> createReadSession(Storage.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.
 Read sessions automatically expire 24 hours after they are created and do
 not require manual clean-up by the caller.
 

batchCreateReadSessionStreams

public com.google.common.util.concurrent.ListenableFuture<Storage.BatchCreateReadSessionStreamsResponse> batchCreateReadSessionStreams(Storage.BatchCreateReadSessionStreamsRequest request)

 Creates additional streams for a ReadSession. This API can be used to
 dynamically adjust the parallelism of a batch processing task upwards by
 adding additional workers.
 

finalizeStream

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> finalizeStream(Storage.FinalizeStreamRequest request)

 Triggers the graceful termination of a single stream in a ReadSession. This
 API can be used to dynamically adjust the parallelism of a batch processing
 task downwards without losing data.
 This API does not delete the stream -- it remains visible in the
 ReadSession, and any data processed by the stream is not released to other
 streams. However, no additional data will be assigned to the stream once
 this call completes. Callers must continue reading data on the stream until
 the end of the stream is reached so that data which has already been
 assigned to the stream will be processed.
 This method will return an error if there are no other live streams
 in the Session, or if SplitReadStream() has been called on the given
 Stream.
 

splitReadStream

public com.google.common.util.concurrent.ListenableFuture<Storage.SplitReadStreamResponse> splitReadStream(Storage.SplitReadStreamRequest request)

 Splits a given read stream into two Streams. These streams are referred to
 as the primary and the residual of the split. The original stream can still
 be read from in the same manner as before. Both of the returned streams can
 also be read from, and the total rows return 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 Stream. 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.
 This method is guaranteed to be idempotent.