Package com.google.bigtable.v2

Class BigtableGrpc.BigtableBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

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

com.google.bigtable.v2.BigtableGrpc.BigtableBlockingStub

Enclosing class:

BigtableGrpc

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

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	Description
protected BigtableGrpc.BigtableBlockingStub	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.
Iterator<GenerateInitialChangeStreamPartitionsResponse>	generateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request)	NOTE: This API is intended to be used by Apache Beam BigtableIO.
MutateRowResponse	mutateRow(MutateRowRequest request)	Mutates a row atomically.
Iterator<MutateRowsResponse>	mutateRows(MutateRowsRequest request)	Mutates multiple rows in a batch.
PingAndWarmResponse	pingAndWarm(PingAndWarmRequest request)	Warm up associated instance metadata for this connection.
Iterator<ReadChangeStreamResponse>	readChangeStream(ReadChangeStreamRequest request)	NOTE: This API is intended to be used by Apache Beam BigtableIO.
ReadModifyWriteRowResponse	readModifyWriteRow(ReadModifyWriteRowRequest request)	Modifies a row atomically on the server.
Iterator<ReadRowsResponse>	readRows(ReadRowsRequest request)	Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each.
Iterator<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, 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 BigtableGrpc.BigtableBlockingStub build(io.grpc.Channel channel,
                                                  io.grpc.CallOptions callOptions)

Specified by:

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

readRows

public Iterator<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

public Iterator<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)

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

mutateRows

public Iterator<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)

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

pingAndWarm

public PingAndWarmResponse pingAndWarm(PingAndWarmRequest request)

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

readModifyWriteRow

public ReadModifyWriteRowResponse readModifyWriteRow(ReadModifyWriteRowRequest request)

 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.
 

generateInitialChangeStreamPartitions

public Iterator<GenerateInitialChangeStreamPartitionsResponse> generateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request)

 NOTE: This API is intended to be used by Apache Beam BigtableIO.
 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`.
 

readChangeStream

public Iterator<ReadChangeStreamResponse> readChangeStream(ReadChangeStreamRequest request)

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