com.google.bigtable.v2

Class BigtableGrpc.BigtableBlockingV2Stub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<BigtableGrpc.BigtableBlockingV2Stub>

com.google.bigtable.v2.BigtableGrpc.BigtableBlockingV2Stub

Enclosing class:

BigtableGrpc

public static final class BigtableGrpc.BigtableBlockingV2Stub
extends io.grpc.stub.AbstractBlockingStub<BigtableGrpc.BigtableBlockingV2Stub>

A stub to allow clients to do synchronous rpc calls to service Bigtable.

 Service for reading from and writing to existing Bigtable tables.
 

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
protected BigtableGrpc.BigtableBlockingV2Stub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
CheckAndMutateRowResponse	checkAndMutateRow(CheckAndMutateRowRequest request) Mutates a row atomically based on the output of a predicate Reader filter.
io.grpc.stub.BlockingClientCall<?,ExecuteQueryResponse>	executeQuery(ExecuteQueryRequest request) Executes a SQL query against a particular Bigtable instance.
io.grpc.stub.BlockingClientCall<?,GenerateInitialChangeStreamPartitionsResponse>	generateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request) Returns the current list of partitions that make up the table's change stream.
ClientConfiguration	getClientConfiguration(GetClientConfigurationRequest request) This RPC is only intended to be used by the official Cloud Bigtable client libraries to implement the Bigtable Session based protocol.
MutateRowResponse	mutateRow(MutateRowRequest request) Mutates a row atomically.
io.grpc.stub.BlockingClientCall<?,MutateRowsResponse>	mutateRows(MutateRowsRequest request) Mutates multiple rows in a batch.
io.grpc.stub.BlockingClientCall<SessionRequest,SessionResponse>	openAuthorizedView() This RPC is only intended to be used by the official Cloud Bigtable client libraries to implement the Bigtable Session based protocol.
io.grpc.stub.BlockingClientCall<SessionRequest,SessionResponse>	openMaterializedView() This RPC is only intended to be used by the official Cloud Bigtable client libraries to implement the Bigtable Session based protocol.
io.grpc.stub.BlockingClientCall<SessionRequest,SessionResponse>	openTable() This RPC is only intended to be used by the official Cloud Bigtable client libraries to implement the Bigtable Session based protocol.
PingAndWarmResponse	pingAndWarm(PingAndWarmRequest request) Warm up associated instance metadata for this connection.
PrepareQueryResponse	prepareQuery(PrepareQueryRequest request) Prepares a GoogleSQL query for execution on a particular Bigtable instance.
io.grpc.stub.BlockingClientCall<?,ReadChangeStreamResponse>	readChangeStream(ReadChangeStreamRequest request) Reads changes from a table's change stream.
ReadModifyWriteRowResponse	readModifyWriteRow(ReadModifyWriteRowRequest request) Modifies a row atomically on the server.
io.grpc.stub.BlockingClientCall<?,ReadRowsResponse>	readRows(ReadRowsRequest request) Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each.
io.grpc.stub.BlockingClientCall<?,SampleRowKeysResponse>	sampleRowKeys(SampleRowKeysRequest request) Returns a sample of row keys in the table.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

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

Methods inherited from class java.lang.Object

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

Method Detail

build

protected BigtableGrpc.BigtableBlockingV2Stub build(io.grpc.Channel channel,
                                                    io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<BigtableGrpc.BigtableBlockingV2Stub>

readRows

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<?,ReadRowsResponse> readRows(ReadRowsRequest request)

 Streams back the contents of all requested rows in key order, optionally
 applying the same Reader filter to each. Depending on their size,
 rows and cells may be broken up across multiple responses, but
 atomicity of each row will still be preserved. See the
 ReadRowsResponse documentation for details.
 

sampleRowKeys

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<?,SampleRowKeysResponse> sampleRowKeys(SampleRowKeysRequest request)

 Returns a sample of row keys in the table. The returned row keys will
 delimit contiguous sections of the table of approximately equal size,
 which can be used to break up the data for distributed tasks like
 mapreduces.
 

mutateRow

public MutateRowResponse mutateRow(MutateRowRequest request)
                            throws io.grpc.StatusException

 Mutates a row atomically. Cells already present in the row are left
 unchanged unless explicitly changed by `mutation`.
 

Throws:

io.grpc.StatusException

mutateRows

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<?,MutateRowsResponse> mutateRows(MutateRowsRequest request)

 Mutates multiple rows in a batch. Each individual row is mutated
 atomically as in MutateRow, but the entire batch is not executed
 atomically.
 

checkAndMutateRow

public CheckAndMutateRowResponse checkAndMutateRow(CheckAndMutateRowRequest request)
                                            throws io.grpc.StatusException

 Mutates a row atomically based on the output of a predicate Reader filter.
 

Throws:

io.grpc.StatusException

pingAndWarm

public PingAndWarmResponse pingAndWarm(PingAndWarmRequest request)
                                throws io.grpc.StatusException

 Warm up associated instance metadata for this connection.
 This call is not required but may be useful for connection keep-alive.
 

Throws:

io.grpc.StatusException

readModifyWriteRow

public ReadModifyWriteRowResponse readModifyWriteRow(ReadModifyWriteRowRequest request)
                                              throws io.grpc.StatusException

 Modifies a row atomically on the server. The method reads the latest
 existing timestamp and value from the specified columns and writes a new
 entry based on pre-defined read/modify/write rules. The new value for the
 timestamp is the greater of the existing timestamp or the current server
 time. The method returns the new contents of all modified cells.
 

Throws:

io.grpc.StatusException

generateInitialChangeStreamPartitions

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<?,GenerateInitialChangeStreamPartitionsResponse> generateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request)

 Returns the current list of partitions that make up the table's
 change stream. The union of partitions will cover the entire keyspace.
 Partitions can be read with `ReadChangeStream`.
 NOTE: This API is only intended to be used by Apache Beam BigtableIO.
 

readChangeStream

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<?,ReadChangeStreamResponse> readChangeStream(ReadChangeStreamRequest request)

 Reads changes from a table's change stream. Changes will
 reflect both user-initiated mutations and mutations that are caused by
 garbage collection.
 NOTE: This API is only intended to be used by Apache Beam BigtableIO.
 

prepareQuery

public PrepareQueryResponse prepareQuery(PrepareQueryRequest request)
                                  throws io.grpc.StatusException

 Prepares a GoogleSQL query for execution on a particular Bigtable instance.
 

Throws:

io.grpc.StatusException

executeQuery

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<?,ExecuteQueryResponse> executeQuery(ExecuteQueryRequest request)

 Executes a SQL query against a particular Bigtable instance.
 

getClientConfiguration

public ClientConfiguration getClientConfiguration(GetClientConfigurationRequest request)
                                           throws io.grpc.StatusException

 This RPC is only intended to be used by the official Cloud Bigtable client
 libraries to implement the Bigtable Session based protocol. It is subject
 to change without notice.
 

Throws:

io.grpc.StatusException

openTable

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<SessionRequest,SessionResponse> openTable()

 This RPC is only intended to be used by the official Cloud Bigtable client
 libraries to implement the Bigtable Session based protocol. It is subject
 to change without notice.
 

openAuthorizedView

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<SessionRequest,SessionResponse> openAuthorizedView()

 This RPC is only intended to be used by the official Cloud Bigtable client
 libraries to implement the Bigtable Session based protocol. It is subject
 to change without notice.
 

openMaterializedView

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<SessionRequest,SessionResponse> openMaterializedView()

 This RPC is only intended to be used by the official Cloud Bigtable client
 libraries to implement the Bigtable Session based protocol. It is subject
 to change without notice.